search

max-mapper / art-of-node

:snowflake: a short introduction to node.js
https://github.com/maxogden/art-of-node#the-art-of-node
Other
9.81k stars 854 forks source link

Why not use GitHub pages to host this doc? #48

Open babhishek21 opened 9 years ago

babhishek21 commented 9 years ago

Hey, Why not use GitHub pages to host this doc? That way you can both maintain a repository and also get a working site for displaying this doc. BTW this doc is awesome.

max-mapper commented 9 years ago

Good idea, i just never got around to making any html/css for this

On Saturday, January 24, 2015, Abhishek Bhattacharya < notifications@github.com> wrote:

Hey, Why not use GitHub pages to host this doc? That way you can both maintain a repository and also get a working site for displaying this doc. BTW this doc is awesome.

— Reply to this email directly or view it on GitHub https://github.com/maxogden/art-of-node/issues/48.

Sent from my phone

zeke commented 9 years ago

I added a package.json to my fork of this repo and published it to npm to see how it would look. The answer: not too shabby, but it's in Spanish. The npm readme-detector-ma-jig appears to prefer the spanish language README: https://www.npmjs.com/package/art-of-node

For personal reference, I think that detection happens somewhere in here: https://github.com/npm/read-package-json/blob/master/read-json.js#L230-L245

Delta0001 commented 8 years ago

@maxogden You can easily make a page by using Github's very own Automatic Github Page generator showcased here https://github.com/blog/1081-instantly-beautiful-project-pages

Literally takes 4-5 clicks to get the page ready.

If you want to go through a bit more work, you can use Docsync http://coryg89.github.io/docsync/

Hillsie commented 8 years ago

Thanks Dudi, I've been working through his stuff. ...art of node.

I didn't know one could get a page quite as good as the examples

On Thursday, 5 May 2016, David notifications@github.com wrote:

@maxogden https://github.com/maxogden You can easily make a page by using Github's very own Automatic Github Page generator showcased here https://github.com/blog/1081-instantly-beautiful-project-pages

Literally takes 4-5 clicks to get the page ready.

If you want to go through a bit more work, you can use Docsync http://coryg89.github.io/docsync/

— You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub https://github.com/maxogden/art-of-node/issues/48#issuecomment-217095462

bmix commented 7 years ago

So? It's 2017 ;-)

As they say at https://pages.github.com/

  1. Create a repository
  2. Clone the repository
  3. Enter the project folder and add an index.html file
  4. Push it
  5. …and you're done!