HyperDoc 2.0 Examples

§1 Paragraphs and Inline Text

This paragraph shows plain text mixed with emphasis, strike-through, and monospaced spans.

Dieser Absatz zeigt das Attribut lang auf Blockebene.

This paragraph uses a string literal body instead of a list.

Inline scripts support const version = "2.0"; as well as sub/superscripts like H₂O and x².

Links can target other blocks or external resources.

§2 Lists

§2.1 Unordered Lists

• Apples

• Bananas

• Cucumbers with inline markup.

§2.2 Ordered Lists

3. Start counting at three.

4. Continue with a string item.

5. Finish the sequence.

§3 Admonitions

§4 Literal and Preformatted Blocks

Literal blocks keep exact content and skip parsing, so characters like \{ \} are not special. They are introduced by a trailing colon. You can capture snippets without escaping anything.

test {
    const message = "HyperDoc";
    const answer = 42;
}

§5 Figures

The image below has a caption, alt text, and a relative asset path.

§6 Dates and Times

The event was announced on +2025-12-17 at 13:45 Z. A combined timestamp looks like +2025-12-17T13:45:00Z.

§7 References

In chapter 1. Paragraphs and Inline Text we've read about how we can format paragraphs. This chapter here teaches about references.

References to another chapter can use the numeric value (like 2.2.), use only the name (like Tables) or we can use a custom name like with regular links.

§8 Tables

See the dedicated tables example file for row groups and colspan usage.