Markdown Features
Goldmark Extensions
Section titled “Goldmark Extensions”All Goldmark extensions are enabled:
| Extension | Syntax |
|---|---|
| Tables | Standard GFM pipe-delimited tables |
| Strikethrough | ~~deleted~~ |
| Task lists | - [ ] / - [x] |
| Definition lists | Term followed by : definition |
| Footnotes | [^1] with [^1]: text |
| Auto headings | Slugged heading IDs for anchor links |
| Linkify | Bare URLs auto-linked |
| Typographer | Smart quotes, dashes, ellipses |
Syntax Highlighting
Section titled “Syntax Highlighting”Chroma with Monokai theme supports 200+ languages:
```gofunc main() { fmt.Println("Hello, World!")}```Rendering happens server-side. No client-side JavaScript needed for highlighting.
Diagrams
Section titled “Diagrams”D2 (Server-Side SVG)
Section titled “D2 (Server-Side SVG)”D2 diagrams are compiled to SVG at render time:
```d2x -> y: helloy -> z: world```Mermaid (Client-Side)
Section titled “Mermaid (Client-Side)”Mermaid diagrams load the library on-demand — only when a page contains a mermaid block:
```mermaidgraph LR A[Start] --> B{Decision} B -->|Yes| C[Action] B -->|No| D[End]```Admonition Blocks
Section titled “Admonition Blocks”GitHub-style callout blocks using blockquote syntax:
> [!NOTE]> Useful information that users should be aware of.
> [!WARNING]> Critical content that needs extra attention.Six alert types with distinct colors:
| Type | Color | Use case |
|---|---|---|
NOTE |
Blue | Informational notes |
TIP |
Green | Helpful suggestions |
IMPORTANT |
Purple | Key information |
WARNING |
Amber | Cautionary advice |
CAUTION |
Red | Potential risks |
CRITICAL |
Intense red | Urgent/essential information |
Frontmatter
Section titled “Frontmatter”YAML metadata at the top of each file:
---title: "Page Title"description: "Page description"author: "Author Name"tags: ["go", "markdown"]draft: false---Files with draft: true are excluded from the site.
Table of Contents
Section titled “Table of Contents”Auto-generated from headings (h2+) with:
- Hierarchical nesting (parent/child items)
- URL-friendly anchor links
- Sidebar navigation in the file view
Reading Time
Section titled “Reading Time”Estimated at 200 words per minute, displayed in the article header.