2.6 KiB
Markdown Extensions
Directory Index Customisation
By default, directories without an index.md get an auto-generated index page listing their contents.
If you create your own index.md in a directory, you can still include the auto-generated file list by using the {{LIST}} placeholder:
# Blog
This is my blog. The posts are below. The top-most one is the most recent.
{{LIST}}
The {{LIST}} placeholder is replaced with the autogenerated file list.
Table of Contents
{{TOC}} auto-generates a nested heading list with clickable anchors.
Footnotes
Full support for [^id] footnotes and [^id]: text definitions. They render as a numbered <section> at the bottom of the page.
Definition Lists
Definition lists use the standard syntax:
Term
: Definition
This renders as <dl><dt>Term</dt><dd>Definition</dd></dl>. Multiple definitions per term are supported.
Emoji Shortcodes
Standard GitHub/MkDocs emoji shortcodes like :smile:, :fire:, :rocket: are automatically replaced with their Unicode emoji equivalents. Shortcodes inside code blocks are left as-is.
Pipe Tables
Tables use the GitHub-style syntax:
| Header 1 | Header 2 |
|---|---|
| cell 1 | cell 2 |
| cell 3 | cell 4 |
Column alignment is set with colons in the separator:
| Left | Center | Right |
|:---|:---:|---:|
| a | b | c |
Tables can drop the header row and with a separator:
|---|---|
| a | b |
Blockquotes
Standard Markdown blockquote syntax using >:
> This is a blockquote.
> It can span multiple lines.
Admonitions
Blockquotes that start with a type tag become styled admonition blocks. Five built-in types are supported: NOTE, TIP, IMPORTANT, WARNING, CAUTION.
> [!NOTE]
> This is a note admonition.
Custom admonition types can be added via the custom_admonitions config option in site.conf.
Task Lists
GFM-style task lists are supported inside both ordered and unordered lists:
- [ ] Unchecked item
- [x] Checked item
- Normal item
1. [ ] Unchecked item
2. [x] Checked item
3. Normal item
Reference Links
Markdown reference-style links and images are supported:
[link text][ref]
[ref]: https://example.com "Optional title"
![alt text][img-ref]
[img-ref]: /image.png "Optional title"
Plain Text Blocks
Content inside <plain>...</plain> tags is rendered without any Markdown processing
MFM Font Syntax
Misskey-style font syntax is supported for inline font family changes:
$[font.serif text]- serif font$[font.mono text]- monospace font$[font.sans text]- sans-serif font