zudo-doc
GitHub repository

Type to search...

to open search from anywhere

Basic Components

Created Mar 14, 2026Updated Jul 15, 2026Takeshi Takatsudo

Standard Markdown and MDX typography elements available in documentation pages.

These are the standard Markdown and MDX elements styled through zudo-doc's design token system. No imports are needed.

Headings

Headings from h2 to h4 appear in the table of contents sidebar.

Heading 3

Heading 4

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

Overriding Content Typography

The page-title, content-heading, prose, and link typography above is driven by component tokens--zdc-* CSS custom properties the @takazudo/zudo-doc package exposes as override seams. Because the components ship from the package (you cannot edit them directly), these tokens are your scope: redefine any of them in your own :root to rebrand the content area across every page, with no !important and no eject.

src/styles/global.css
:root {
  --zdc-doc-title-font: "Georgia", serif;
  --zdc-doc-title-weight: 800;
}
TokenComponentDefaultWhat it controls
--zdc-doc-title-fontdoc-titleinheritFont family of the page-title <h1>.
--zdc-doc-title-weightdoc-titlevar(--font-weight-bold)Font weight of the page-title <h1>.
--zdc-doc-title-trackingdoc-titlevar(--tracking-normal)Letter spacing of the page-title <h1>.
--zdc-doc-h2-fontheading-h2inheritFont family of content <h2> headings.
--zdc-doc-h2-weightheading-h2var(--font-weight-bold)Font weight of content <h2> headings.
--zdc-doc-h2-trackingheading-h2var(--tracking-normal)Letter spacing of content <h2> headings.
--zdc-doc-h3-weightheading-h3var(--font-weight-bold)Font weight of content <h3> headings.
--zdc-doc-h4-weightheading-h4var(--font-weight-semibold)Font weight of content <h4> headings.
--zdc-doc-prose-fontdoc-prosevar(--font-sans)Font family of the .zd-content prose area. Headings with --zdc-doc-*-font: inherit inherit this value.
--zdc-doc-link-decorationcontent-linkunderlineText decoration of styled content links. Set to none to remove underlines.
--zdc-admonition-radiusadmonition0 var(--radius-DEFAULT) var(--radius-DEFAULT) 0Border radius of admonition/callout blocks.
--zdc-admonition-border-widthadmonition4pxWidth of the admonition left accent border.

For the full rundown — the ownership-inversion rationale, how these fit the three-tier token story, chrome tokens (card radius, TOC width, nav active styles), and why they are not editable in the Design Token Panel — see Component Tokens.

Text Formatting

Bold text, italic text, and strikethrough. Combine them: bold and italic.

**Bold text**, *italic text*, and ~~strikethrough~~.
Combine them: ***bold and italic***.

Inline Code

Use backticks to mark inline code within a sentence.

Use backticks to mark `inline code` within a sentence.

Code Blocks

Fenced code blocks use zfb's build-time semantic class-mode highlighter. Specify the language after the opening backticks. See the Code Blocks page for the full rundown.

function greet(name: string): string {
  return `Hello, ${name}!`;
}
```ts

function greet(name: string): string {
  return `Hello, ${name}!`;
}

```

Supported Languages

zfb's class-mode highlighter supports a wide range of languages. Common ones include:

LanguageIdentifier
TypeScriptts, typescript
JavaScriptjs, javascript
HTMLhtml
CSScss
JSONjson
Bash / Shellbash, sh, shell, zsh
Markdownmd, markdown
MDXmdx
YAMLyaml, yml
Pythonpython, py
Rustrust, rs
Gogo
SQLsql
GraphQLgraphql
Diffdiff
TOMLtoml
JSX / TSXjsx, tsx

If a language identifier isn't recognised, the block falls back to a plain unhighlighted render.

Unordered Lists

  • First item

  • Second item

    • Nested item

    • Another nested item

      • Deeply nested

  • Third item

- First item
- Second item
  - Nested item
  - Another nested item
    - Deeply nested
- Third item

Ordered Lists

  1. First step

  2. Second step

  3. Sub-step one

  4. Sub-step two

  5. Third step

1. First step
2. Second step
   1. Sub-step one
   2. Sub-step two
3. Third step

Blockquotes

This is a blockquote. It can span multiple lines and supports formatting within it.

> This is a blockquote. It can span multiple lines
> and supports **formatting** within it.

Tables

FeatureStatusNotes
MDXSupportedBuilt into zfb
zfb class modeBuilt-inCode highlighting
Tailwindv4Token-based design
| Feature    | Status      | Notes              |
| ---------- | ----------- | ------------------ |
| MDX        | Supported   | Built into zfb     |
| zfb class mode | Built-in | Code highlighting |
| Tailwind   | v4          | Token-based design |

Internal link: Getting Started

External link: Example external site

Internal link: [Getting Started](../getting-started/index.mdx)

External link: [Example external site](https://example.com)

Horizontal Rules

Use three dashes to create a horizontal rule:


---

Revision History

Takeshi TakatsudoCreated: 2026-03-14T21:09:02+09:00Updated: 2026-07-16T08:33:16+09:00

AI Assistant

Ask a question about the documentation.

Preview theme

Loading theme previews…