Markdown
Zudoku supports GitHub Flavored Markdown (GFM) with additional features for creating rich documentation.
Basic Formatting
Headers
Use #
to create headers. The number of #
symbols determines the header level:
Code(md)
Text Formatting
Code(mdx)
Bold text
Italic text
Strikethrough text
Inline code
Lists
Unordered lists:
Code(md)
Ordered lists:
Code(md)
See list examples
Unordered list:
- Item 1
- Item 2
- Nested item
- Another nested item
Ordered list:
- First item
- Second item
- Nested item
- Another nested item
Links and Images
Code(md)
Tables
Code(md)
See table example
Header 1 | Header 2 | Header 3 |
---|---|---|
Cell 1 | Cell 2 | Cell 3 |
Cell 4 | Cell 5 | Cell 6 |
Blockquotes
Code(md)
See blockquote example
This is a blockquote
It can span multiple lines
Frontmatter
Frontmatter allows you to configure page metadata using YAML at the beginning of your markdown files:
Code(md)
Common frontmatter properties include title
, description
, sidebar_icon
, and category
. For a complete list of supported properties, see the Frontmatter documentation.
MDX Support
Zudoku supports MDX, allowing you to use JSX components within your markdown:
my-page.mdx(mdx)
MDX enables you to create interactive documentation with custom React components. Learn more in the MDX documentation.
Syntax Highlighting
Zudoku uses Shiki for syntax highlighting in code blocks:
Code(md)
Advanced features:
- Line highlighting:
{1,3-5}
- Word highlighting:
/keyword/
- Line numbers:
showLineNumbers
- Titles:
title="filename.js"
Code
See advanced features example
Counter.tsx(tsx)
For complete syntax highlighting documentation, see Code Blocks.
Additional Features
Zudoku also supports:
- Admonitions - Callout boxes for notes, warnings, and tips
- Task lists with checkboxes
- Emoji support :tada:
- Automatic link detection
Task Lists
Code(md)
See task list example
- Completed task
- Incomplete task
- Another task
Collapsible Sections
You can create collapsible content using HTML <details>
and <summary>
tags:
Code(html)
Click to expand
This content is hidden by default and can be expanded by clicking the summary.
You can include any markdown content here:
- Lists
- Bold text
- Code blocks
- Images