Markdown

DocAnvil renders Markdown using comrak with GitHub Flavored Markdown (GFM) extensions enabled. Everything you'd expect from standard Markdown works, plus tables, task lists, strikethrough, footnotes, and front matter.

Text Formatting

Bold text is wrapped in double asterisks: **bold**

Italic text uses single asterisks: *italic*

Strikethrough uses double tildes: ~~strikethrough~~

You can combine them: bold and italic, bold strikethrough

Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Heading 1 gets a colored bottom border. Heading 2 gets a subtle separator line. Headings 3 and 4 are unstyled dividers.

Links and Images

Standard Markdown links: [text](url)

Images: ![alt text](image-url)

For linking between documentation pages, use wiki-links instead — they resolve automatically and warn on broken references.

Lists

Unordered

• First item
• Second item
  • Nested item
  • Another nested item
• Third item

Ordered

1. Step one
2. Step two
3. Step three
   1. Sub-step
   2. Another sub-step

Task Lists

• Write the documentation
• Add code examples
• Review and publish
• Celebrate

Task lists render as checkboxes. Use - [x] for checked and - [ ] for unchecked items.

Tables

Tables support column alignment with colons in the separator row:

| Left | Center | Right |
|:-----|:------:|------:|
| a    |   b    |     c |

Code Blocks

Inline code uses single backticks: let x = 42;

Fenced code blocks use triple backticks with an optional language identifier:

fn main() {
    println!("Hello from DocAnvil!");
}

const greet = (name) => {
  console.log(`Hello, ${name}!`);
};

Blockquotes

Blockquotes are rendered with a colored left border and a subtle background.

They can span multiple paragraphs.

Use > at the start of each line.

Footnotes

DocAnvil supports footnotes¹ using the standard syntax. Reference them inline with [^name] and define them anywhere in the document.

Here's another example with a longer footnote².

Front Matter

Pages can include YAML front matter between --- delimiters at the top of the file:

---
title: My Page Title
author: Jane Doe
---

# Page Content

Front matter is stripped from the output. It's available for future use with template variables.

Horizontal Rules

Three or more hyphens, asterisks, or underscores create a horizontal rule:

---

Inline Attributes

DocAnvil supports a post-processing pass for inline attributes. Place {.class #id} on the line immediately after an element to inject HTML attributes:

## My Section
{#custom-id .highlighted}

This renders as <h2 id="custom-id" class="highlighted">My Section</h2>.

Supported shorthand:

Multiple classes can be combined: {.first .second #my-id}

Related Pages

• Wiki-links — double-bracket links and inline popovers
• Components — notes, warnings, tabs, and code groups