Markdown 预览
用真实 .md 文件测试标题、表格、代码块、Admonitions 和 GFM 语法。
Markdown 渲染预览
这是一份真实的 .md 文件,用来检查文档站里 Markdown 的基础渲染效果。你可以直接修改 content/docs/markdown-preview.md,刷新浏览器后查看变化。
常见语法
Markdown 页面现在支持 粗体、斜体、inline code、链接,以及 GitHub Flavored Markdown 的表格。
这是一段引用。适合放提示、设计约束、风险说明或重要背景。
列表
- 使用
lib/docs.ts注册 Markdown 文件。 - 使用
react-markdown渲染正文。 - 使用
remark-gfm支持表格等 GFM 语法。
- 添加
.md文件。 - 在文档索引里配置
markdownFile。 - 打开对应
/docs/[slug]页面查看效果。
表格
| 类型 | 用途 | 状态 |
|---|---|---|
| 标题 | 页面层级和目录结构 | 已支持 |
| 代码块 | 展示命令和示例代码 | 已支持 |
| 表格 | 参数、字段、能力矩阵 | 已支持 |
代码块
type DocItem = {
slug: string
title: string
description: string
markdownFile?: string
}
npm run dev
npm run lint
npm run typecheck
后续可扩展方向
当前是轻量 Markdown 渲染。如果后面需要 frontmatter、目录自动生成、代码高亮、MDX 组件或全文搜索,可以在这个入口继续扩展。