RIDDL Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
Edit page

Description

Descriptions describe definitions. You can add a description to any kind of definition. Descriptions are written in Markdown format and can include any of the capabilities provided by the GeekDoc hugo formatter including mermaid based diagrams. Descriptions can also be provided in separate files and via public (no password required) HTTP URLs.

Occurs On

Every kind of definition.

Contains

Markdown text either directly in RIDDL, in a file, or via a URL.