Muze Development Tools: Docify
What it is
This library turns your library folders into a documentation website. It looks for readme.md templates and compiles them to html.
Load docify in the root of your library set. e.g.:
<pinp> $muzeLibs = ar::acquire('env.libs.muze') ?: '/system/lib/muze/'; loadLibrary(ARUNNAMED, $muzeLibs.'dev/docify/'); </pinp>
Then add readme.md templates in each of your libraries. You can now open a library with 'view webpage' in the Ariadne backend and your readme.md files will be shown as HTML.
Docify will automatically add a navigation sidebar which shows all templates ending with
If you find yourself writing a lot of seperate markdown files, you may want to create a subfolder
that contains just the documentation. This prevents all your documentation templates crowding
the template lists in Ariadne's IDE.
Take a look at the readme.md you are reading now.
Here are some links about writing good technical documentation: