Writing Content

Kabra uses a clean, tailored subset of Markdown features suited for documentation and static sites.

Sidebar Ordering

Kabra automatically generates a sidebar navigation menu based on your Markdown files. By default, files are sorted alphabetically by their filename.

To control the exact order of pages in the sidebar, you can prefix your filenames with a number followed by a hyphen or underscore.

Example File Structure:

• 1-index.md

• 2-features.md

• 3-getting-started.md

• faq.md

Kabra will strip the [number]- prefix when generating the slug and HTML file name. For instance, 3-getting-started.md becomes getting-started.html, and will appear in the sidebar ordered according to the number 3. Unnumbered files like faq.md will be sorted alphabetically after the numbered ones.

Internal Linking

You can link between your Markdown files seamlessly. Kabra automatically transforms relative links ending in .md to their corresponding .html output files, honoring the stripped numerical prefixes.

<!-- Links to 3-getting-started.md -->
[Read the Getting Started guide](./3-getting-started.md)

In the generated HTML, this link will point to ./getting-started.html.