Hi folks!
Today, I put together a proof-of-concept git repo with another documentation tool, VuePress:
My repo takes Markdown files in a docs/
directory of a GitHub project and generates HTML documentation site from them. It does this all automatically within GitHub. When you make a commit to master
, Travis CI builds a copy of your site locally. If it builds successfully, Travis automatically deploys the latest built version of your content into GitHub Pages.
I did this as an experiment and learning exercise, and thought others might find it useful. It’s also set up as a GitHub template repo, so it should be especially easy to fork it and use it for your own stuff!