Github to index.html converter
Last updated 8 years ago by bebraw .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install readme2gh 
SYNC missed versions from official npm registry.

readme2gh - Updates your gh sites pages based on

This tool updates the contents of your gh-pages index.html based on your projects's at master branch. Effectively this makes it really easy to keep your project info in sync in case you happen to use and index in tandem.


  1. sudo npm install -g to install the script
  2. Create index.tpl and place {{ content }} tag in place of current README content. The tool will inject your README there.
  3. Execute readme2gh. This will update your index.html based on your index.tpl.
  4. Preview the changes locally, commit and push.

Set up a cronjob or something if you want to be truly lazy.


ghw is available under MIT. See LICENSE for more details.

Current Tags

  • 0.1.0                                ...           latest (8 years ago)

1 Versions

  • 0.1.0                                ...           8 years ago
Maintainers (1)
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (2)
Dev Dependencies (0)
Dependents (1)

Copyright 2014 - 2016 © |