Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Writing in Markdown

Articles are standard Markdown — the same dialect you use in GitHub READMEs. There is no custom syntax to learn.

Supported features

Headings

## Section
### Subsection

Start body headings at ## (the article title is the #). Every heading gets an anchor link (hover to see the #), and articles with three or more ##/### headings get an automatic table of contents.

Code blocks

Fenced blocks with a language get build-time syntax highlighting and a Copy button:

```rust
fn main() {
    println!("hello");
}
```

Tables

| Flag | Meaning |
|------|---------|
| `-v` | verbose |

Task lists

- [x] write the draft
- [ ] add benchmarks

Quotes

> Simple is robust.

Footnotes

Rust's borrow checker helps here.[^1]

[^1]: Most of the time.

The footnote body can go anywhere in the file; footnotes render at the bottom of the article.

[link text](https://example.com)
[another article](/2026/05/hello-world/)
![diagram](images/architecture.png)

Link to your own articles with their site-absolute path (/2026/05/hello-world/). Images are covered in the next chapter.

What happens automatically

  • Reading time is computed from word count.
  • The table of contents builds itself from your headings.
  • Code blocks get a language label and Copy button.
  • The article’s full text becomes searchable via the site search (⌘K).

You never need HTML, shortcodes, or layout tweaks inside an article.