Markdown
Markdown pages combine plain text with a small set of formatting conventions. This page exercises the shared renderer; dedicated guides explain typography, code blocks, mathematics and diagrams in more detail.
Everyday Markdown
Use strong, emphasis, deleted text and inline code when they convey meaning. Links between these chapters are relative, so they remain beneath the site’s configured base path.
- Write a short example.
- Check it in the built site.
- Add the next chapter.
Formulas
Inline math is rendered during the build: . A configured macro works in .
Long formulas scroll within their container on small screens:
An intentional invalid command stays readable instead of breaking the page: .
Diagrams
flowchart LR
Source[Markdown source] --> Build[Static Astro build]
Build --> Math[KaTeX HTML]
Build --> Diagram[Lazy Mermaid runtime]
Math --> Reader[Reader]
Diagram --> Reader
This deliberately invalid diagram demonstrates source fallback:
flowchart LR
A[Unclosed label --> B
Highlighted code
interface Reader {
name: string;
interests: string[];
}
const reader: Reader = { name: 'Ada', interests: ['math', 'diagrams'] };
console.log(reader);
Wide tables
| Document | Owner | Revision | Reviewed | Scope | Render strategy | Availability |
|---|---|---|---|---|---|---|
| Public guide | Example authors | 12 | 2026-01-15 | Independent synthetic content | Static HTML with optional client features | No account required |
| API reference | Example maintainers | 7 | 2026-02-20 | Consumer-supplied navigation and metadata | Build-time highlighting and math | Public package |
Raw HTML
Native HTML disclosure
Raw HTML remains available to trusted Markdown authors.
Image zoom
Click this synthetic, locally bundled SVG to open the theme image viewer.
Independent diagram errors
Another malformed diagram keeps its own error message, without clearing the earlier example’s message:
sequenceDiagram
invalid sequence syntax ???