编写文档

支持的 Markdown

Fumadocs 会用面向文档站的 preset 编译 Markdown 和 MDX。

• 标题
• 段落和列表
• 表格
• 代码块
• 链接和图片
• 使用 .mdx 文件时可以嵌入 MDX 组件

导航

侧边栏会根据当前语言目录中的 meta.json 和文档文件自动生成。文档访问路径是 /docs/{slug}，其中 {slug} 是去掉 .md 后的文件名。

跳转示例

可以在 Markdown 里写普通链接完成文档互跳：

[返回文档介绍](/docs)
[查看部署说明](/docs/deployment)

页面渲染时会保留当前语言，例如中文页面会跳到 /zh/docs/deployment。