Closed Michael-F-Bryan closed 7 years ago
We should consider the original GitBook. It has built-in GitHub integration (so no fiddling with Travis), has a slick interface, and it's open source as well. Given that we're low on manpower, I'd prefer the solution that takes the least effort to set up and maintain -- GitBook is the best in that regard.
Dupe of #6?
Yep, I'd call it a dupe. Thanks for the pointer.
I've got a personal project which does something pretty similar to this. It's essentially a git repository full of markdown pages.
What I did is use something called mdbook which will take all the markdown files and turn them into structured html. I then added a
travis.yml
which will rebuild the html every time I commit some work and then automatically push to the ghpages branch.I was wondering if you wanted to do something similar to make it easier for people to read and navigate all the useful documents here. It shouldn't require much effort, you just put all the
*.md
source files in asrc
directory and write a shortSUMMARY.md
file to tell mdbook where everything goes.here's my
SUMMARY.md
:And the generated documents are viewable here.