From 21dc56aa6d1583fdaa2396b50edc87e5d606f948 Mon Sep 17 00:00:00 2001 From: "N0\\A" Date: Wed, 1 Apr 2026 15:39:54 +0200 Subject: [PATCH] docs: markdown --- awk/pipe_tables.awk | 2 +- site/docs/markdown.md | 79 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 80 insertions(+), 1 deletion(-) diff --git a/awk/pipe_tables.awk b/awk/pipe_tables.awk index 8e9005b..ec0665d 100644 --- a/awk/pipe_tables.awk +++ b/awk/pipe_tables.awk @@ -50,7 +50,7 @@ END { in_pre = 0 i = 1 while (i <= count) { - if (lines[i] ~ /^
/) {
+        if (lines[i] ~ /^
Term
Definition
`. Multiple definition ## 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: + +```md +| Header 1 | Header 2 | +|---|---| +| cell 1 | cell 2 | +| cell 3 | cell 4 | +``` +Column alignment is set with colons in the separator: + +```md +| Left | Center | Right | +|:---|:---:|---:| +| a | b | c | +``` +Tables can drop the header row and with a separator: + +```md +|---|---| +| a | b | +``` +## Blockquotes + +Standard Markdown blockquote syntax using `>`: + +```md +> 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`. + +```md +> [!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: + +```md +- [ ] 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: + +```md +[link text][ref] + +[ref]: https://example.com "Optional title" + +![alt text][img-ref] + +[img-ref]: /image.png "Optional title" +``` +## Plain Text Blocks + +Content inside `...` 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