|
| 1 | +# dev.github.com |
| 2 | + |
| 3 | +This is a GitHub API resource built with [nanoc][nanoc]. |
| 4 | + |
| 5 | +## Setup |
| 6 | + |
| 7 | +Get the nanoc gem, plus kramdown for markdown parsing: |
| 8 | + |
| 9 | + bundle install |
| 10 | + |
| 11 | +You can see the available commands with nanoc: |
| 12 | + |
| 13 | + nanoc -h |
| 14 | + |
| 15 | +Nanoc has [some nice documentation](http://nanoc.stoneship.org/docs/3-getting-started/) to get you started. Though if you're mainly concerned with editing or adding content, you won't need to know much about nanoc. |
| 16 | + |
| 17 | +[nanoc]: http://nanoc.stoneship.org/ |
| 18 | + |
| 19 | +## Development |
| 20 | + |
| 21 | +Nanoc compiles the site into static files living in `./output`. It's |
| 22 | +smart enough not to try to compile unchanged files: |
| 23 | + |
| 24 | + $ nanoc compile |
| 25 | + Loading site data... |
| 26 | + Compiling site... |
| 27 | + identical [0.00s] output/css/960.css |
| 28 | + identical [0.00s] output/css/pygments.css |
| 29 | + identical [0.00s] output/css/reset.css |
| 30 | + identical [0.00s] output/css/styles.css |
| 31 | + identical [0.00s] output/css/uv_active4d.css |
| 32 | + update [0.28s] output/index.html |
| 33 | + update [1.31s] output/v3/gists/comments/index.html |
| 34 | + update [1.92s] output/v3/gists/index.html |
| 35 | + update [0.25s] output/v3/issues/comments/index.html |
| 36 | + update [0.99s] output/v3/issues/labels/index.html |
| 37 | + update [0.49s] output/v3/issues/milestones/index.html |
| 38 | + update [0.50s] output/v3/issues/index.html |
| 39 | + update [0.05s] output/v3/index.html |
| 40 | + |
| 41 | + Site compiled in 5.81s. |
| 42 | + |
| 43 | +You can setup whatever you want to view the files. If you have the adsf |
| 44 | +gem, however (I hope so, it was in the Gemfile), you can start Webrick: |
| 45 | + |
| 46 | + $ nanoc view |
| 47 | + $ open http://localhost:3000 |
| 48 | + |
| 49 | +## TODO |
| 50 | + |
| 51 | +* Need some way to deploy? Look into GitHub pages to start, until we |
| 52 | + can integrate through a simple hurl.it app for live API calls. |
| 53 | +* Flesh out the missing components of the requests. |
| 54 | +* Maybe add a nice TOC at the top of each page. |
0 commit comments