4 ms·
Because I was not happy with the existing stuff, I've built an opensource project for creating technical online documentations some time ago, named "docEngine".
by chris_engel 11y ago
Because I was not happy with the existing stuff, I've built an opensource project for creating technical online documentations some time ago, named "docEngine". My goals were:
- Easy editing (namely markdown files in folders)
- Runs on "cheap" hosting/everywhere (built with PHP)
- Supports multiple languages (so you can create docs in english, german, etc.)
- Can have editable try-on-your-own demos embedded into the documentation
- SEO friendly (clean URLs and navigation structure)
- Themeable (themes are separated and run with the Twig templating engine)
- Works on mobiles out of the box
- Supports Plugins/Modules for custom content/behaviour
- Formats reference pages for objects/classes/APIs in a nice way
- Supports easy embedding of disqus for user feedback
- Other stuff I forgot right now
The system powers the knowledge base of my recent app "InSite" for web developers: https://www.insite-feedback.com/en/help https://www.insite-feedback.com/en/help
You can see it also in action working - with a different theme - for my javascript UI library "modoJS": http://docs.modojs.com http://docs.modojs.com
That page is a bit more complex. It does _not_ use multiple languages there but it makes great use of the reference pages and has many many editable live-demos. It also has some custom modules like a live build script for the javascript library. At one point it even had a complete user-module with payments but I disabled that when modoJS went opensource.
Another instance of docEngine runs for my pet html5 game engine: http://wearekiss.com/gamekit http://wearekiss.com/gamekit
This one uses the default theme, has most pages in two languages and again incorporates a couple of live demos.
I host a little documentation about the engine itself here, but its not complete right now: http://wearekiss.com/docEngine http://wearekiss.com/docEngine
You can also find the github link to the project in the footer of every hosted documentation.
Have fun with it - I give it away for free. Critics and comments welcome!
Everything I have linked was built by myself.