Components Reference

    This page demonstrates the common MDX elements and custom components available when writing documentation.

    Headings

    H1 Heading (page title)

    H2 Heading

    H3 Heading

    Paragraphs & Inline Code

    Regular paragraph text with an inline code sample like npm run dev that uses the site theme colors.

    Lists

    • Unordered list item
    • Another list item
      • Nested item
    1. Ordered item
    2. Next item

    Blockquote

    This is a blockquote. Use it for quotes or highlighting information.

    You can link to internal pages like Authoring or external sites like Vite.

    Code Blocks (Shiki)

    export function add(a: number, b: number) {
      // Simple addition
      return a + b
    }
     
    console.log(add(2, 3))
    # Shell commands
    npm install
    npm run dev

    Tables

    FeatureStatusNotes
    MDXEnabledFrontmatter + React support
    ShikiEnabledGitHub light/dark themes
    CalloutsAvailablenote, warning, tip, info

    Callouts

    Heads up

    This is a general note for readers.

    Caution

    Be careful when running destructive commands.

    Pro tip

    Use code fences with a language to get proper highlighting.

    FYI

    Content is rendered within a prose container for consistent typography.