The main rules to format the documentation use a specific CSS crafted for rendering: style.css.
Inspired by the ActiveTigger UX
- Primary action:
<span class="action primary">Primary action</span> - Secondary action:
<span class="action secondary">Secondary action</span>
When possible, use similar icons. They are stored in docs/img/icons. Use <span class="icon"></span>.
Supplementary styles
- Main parameters:
<span class="parameter">Main parameters</span> - Secondary parameters:
<span class="parameter secondary">Secondary parameters</span> - Highlight:
<span class="highlight">Highlight</span>
Images
Images are stored in docs/img/. They are included with <div class="img"><img src="../../img/image.png"/></div>.
Other
XXX means that the documentation has to be completed (don't hesitate if you have some time)