-
Notifications
You must be signed in to change notification settings - Fork 19
Description
Have you considered Gitbook as a way to serve your manual? Would look like:
As a user I prefer its interface– it natively has:
- Table of Contents
- Search functionality
- Epub/pdf/etc. auto-builds with each deploy (my dad recently printed the current manual, so there's a need there..)
- More features if you want them? I quite like glossary support, for example.
As far as I can tell, a switch would keep your current features, including an in-browser editor that's pretty well featured (though I don't personally use it so can't fully vouch).
It's free for open source projects, & the project maintainers are responsive on Slack if support is needed. I maintain the Tessel Project (tessel.io) and we switched to Gitbook from a Jekyll-based solution because it was simpler and prettier in the GH view.
Conversion would be pretty simple– right now I'm using a not-really-converted version of your manual via:
git clone
book sm (autogenerate table of contents from file structure)
gitbook serve
which is where I pulled the screen shot from.
Autogen contents sidebar:
I'm currently using Gitbook for a few projects, if you want to poke around examples–
- WIP cartography tutorials: https://frijol.gitbooks.io/orienteering-software-tutorials/content/ (pretty lightweight use)
- Climate change notes for a book: https://frijol.gitbooks.io/climate-change/content/notes/energy/storage.html (much heavier use, hover underlined words if you want to check out the glossary feature)
- Tessel's docs: tessel.io/docs (all of this is auto-deployed when we update content)
Let me know if this is of interest– I can commit a bit of time and don't think it takes much.

