Authoring
How to write documentation
In your MDX folder, create any path/to/my-document.mdx:
---
title: My Document
description: Lorem ipsum...
nav: 0
image: dog.png
---
MARKDOWN
Frontmatter
Any key is optional.
title: if not provided, last part of the path is used:my documentimage:- relative (to the md file) or absolute path, eg:
dog.png,./dog.png,../../dog.png,/dog.pngorhttps://animals.com/dog.png - will be used as metadata image if provided
- relative (to the md file) or absolute path, eg:
nav: order in the navigation (on the same level)
MARKDOWN
TODO