Markdown Features

DocAnvil supports GitHub Flavored Markdown (GFM) with several extensions.

Tables

Task Lists

• Set up project with docanvil init
• Start dev server with docanvil serve
• Write your first page
• Customize the theme

Strikethrough

This text has strikethrough formatting.

Footnotes

DocAnvil is built on comrak¹, which supports GFM footnotes².

Wiki-Links

Link to other pages using double-bracket syntax:

• page-namePage not foud
The linked page doesn't exist: page-name — links using the page title (e.g. components)
• custom textPage not foud
The linked page doesn't exist: page-name — links with custom display text (e.g. API docs)

Code Blocks

Fenced code blocks support syntax highlighting:

fn greet(name: &str) {
    println!("Hello, {}!", name);
}

See components for the built-in directive components, or visit the API Reference for example API documentation.