Tips on documentation platform?
Progressing nicely with my sideproject and want to add documentation. Prefer not to have the docs inside my app but on a purpose build platform so I can iterate over it easily
requirements:
- what you see is what you get editting
- version control
- easily add gifs and images
- responsive
Something that is easily editable like notion and pushed.
What setup do you guys ues?
Gitbook is pretty good and free to use.
We built a knowledge base feature for our product as their are huge SEO benefits of having docs in a subfolder vs subdomain.
https://versoly.com/help is an example.
In the future you will be able to instantly swap designs and build your own without code using our page builder as well.
I'm using Hugo with the GeekDocs theme for my docs. It uses Markdown and re-renders almost instantly when I'm working on them. It's all stored in Git and gets deployed automatically in Netlify when I push to master.
This docs are at the MVP stage, but you can se them as an example: https://docs.appflags.io/javascript/