Skip to content

re: The Unwritten Rules for Github by devdiscuss VIEW POST


I put my project's documentation on GitHub Pages and wrote scripts to assemble up-to-date docs in the gh-pages branch whenever I cut a new version. It took some doing to get everything set up, but it's worked wonders for keeping the docs correct and current without being a major time sink.


I'd like to know about your setup. Care to share in a article or an example repo where I can see it?


The repo is here; look in the build/ directory for the scripts themselves, and in the scripts section of package.json to see how they're wired up. The docs/ directory contains the "source" for the documentation.

I might write up something more detailed soon but no promises -- it's a holiday week here :)

code of conduct - report abuse