| 1 | # ghw - Converts your Github wiki to gh-pages
|
| 2 |
|
| 3 | This tool makes it possible for you to serve the content of your Github wiki pages using gh-pages. This allows you to customize the UI and aggregate information (ie. localized versions) within the same site.
|
| 4 |
|
| 5 | ## Dependencies
|
| 6 |
|
| 7 | * [marked](https://github.com/chjj/marked)
|
| 8 | * [Mu](https://github.com/raycmorgan/Mu)
|
| 9 | * [commander.js](https://github.com/visionmedia/commander.js)
|
| 10 | * [suite.js](https://github.com/bebraw/suite.js)
|
| 11 |
|
| 12 | You can use "sudo npm install marked mu2 commander suite.js" to install these. Note that you won't need commander.js if you use ghw as a module. Also suite.js is optional (needed by tests).
|
| 13 |
|
| 14 | ## Thanks
|
| 15 |
|
| 16 | Big thanks to [guille](https://github.com/guille) for motivating the project! The [Node](https://github.com/joyent/node) guys deserve thanks too.
|
| 17 |
|
| 18 | ## License
|
| 19 |
|
| 20 | ghw is available under MIT. See LICENSE for more details.
|
| 21 |
|