Write your documentation in Markdown inside your repository, versioned with your code. Couscous will turn those Markdown files to HTML.
couscous preview will render the website
on your machine. Tweak the default template, fix some typos
and the changes will be reflected in real time.
couscous deploy will publish your website
on the gh-pages Git branch. GitHub will automatically
put it online and host it for you.
Your website is online, just sit back and relax.
Couscous is different from other static websites generators like Sculpin or Jekyll. These are generic static websites generator, sometimes meant for blogs, and using them to put documentation online is clunky. They also all require a specific directory layout which is incompatible with how we usually store documentation alongside our code.
Couscous is built for simplicity.
It has no requirement on your directory layout, it takes a single command to preview the website and a single one to deploy to GitHub pages.
curl -OS https://couscous.io/couscous.phar php couscous.phar preview
Please note that as Github is using a DDOS protection system, if using CURL fails, just manually download the phar file.
The website should be running at http://localhost:8000/
Markdown Extra support
Fenced code blocks
Responsive default templates
Custom before/after scripts