Inline Directives :name[label]{attributes}
Button
:btn[cmd], :btn[shift], :btn[ctrl], :btn[opt], :btn[enter],
:btn[left], :btn[right], :btn[up], :btn[down], :btn[tab],
:btn[space], :btn[delete], :btn[esc], :btn[custom]Cmd ⌘, Shift ⇧, Ctrl ⌃, Opt ⌥, Enter ↵, ←, →, ↑, ↓, Tab ⇥, Space ␣, Del ⌫, Esc ⎋, Custom
YouTube Link
Watch this video on YouTube: :youtube[Click here]{#dQw4w9WgXcQ}.Watch this video on YouTube: Click here.
Block Directives ::name[label]{attributes}
YouTube Embed
::youtube[Watch this amazing video]{#dQw4w9WgXcQ}Link card
:::linkcard
https://www.google.com/
:::Admonitions
Admonitions are specially formatted content blocks that help highlight important information.Basic Syntax
:::type
Your content here
:::Available Types
:::note
This is a note admonition.
:::Note
This is a note admonition.
Overview
This is an overview admonition.
Warning
This is a warning admonition.
Important
This is an important admonition.
Tip
This is a tip admonition.
Example
This is an example admonition.
Comment
This is a comment admonition.
Quote
This is a quote admonition.
Question
This is a question admonition.
Simple Admonition
This is a simple admonition with a custom title.
This is a simple admonition without a title.
Custom Titles
:::note{title="Did you know?"}
You can customize the title of any admonition!
:::Did you know?
You can customize the title of any admonition!
Nested Admonitions
You can nest admonitions by using more colons in the opening and closing tags:Outer Admonition
This is the outer admonition.
Inner Admonition
This is a nested important admonition.
Best Practices
- Use inline directives (
:) for elements that are part of your text flow - Use block directives (
::) for standalone elements like embeds - Choose appropriate admonition types based on your content
- Use clear, descriptive titles for your admonitions
- Don't overuse admonitions - use them to highlight truly important information