Writing
The true power of this theme is the ability to write documentation in Markdown.
Yes, just Markdown, some components if needed and that's it. A beautiful documentation with a live preview of changes in your browser.
Markdown
With Docus, you can use full Markdown syntax.
What is Markdown?
Images
You can add images using the classic Markdown syntax. They must be stored in the public folder which is at the root of your documentation and accessible from the root of your website.
MDC
Docus use an extended Markdown syntax call MDC to add components to Markdown.
What is MDC?
Components
By default, Docus provide a lot of components to write documentation. You can find the full list of components in the Elements components.
Usage
To use a component, you need to write it using the MDC syntax.
::alert{type="info"}
This is an alert component.
::prop="value".More information about props can be found in the MDC documentation.You can also nest components.
::hero
:::card
A nested card
::card
A super nested card
::
:::
::And you can use inline components to props to spanor to use an icon.
Hello [World]{.bg-blue-500}!\```md [index.md]
<!-- ... -->
\```[ and ] in the code block. This is the filename.Mermaid
You can use Mermaid to create diagrams.
<Mermaid>
flowchart LR
A-- This is the text! ---B
</Mermaid><Mermaid> tag or before the </Mermaid> tag, it will not work.Icons
Yes, that's possible and with ease.
Just find your icon in icones.js.org and copy the name.
:icon{name="noto:astonished-face"}