写作指南
新建文档
在 docs/ 下创建 Markdown 文件,例如 docs/guide/my-first-doc.md:
---
sidebar_position: 2
title: 我的第一篇文档
---
这里开始写正文。
title 设置页面标题,sidebar_position 决定同一目录下的排列顺序。需要 React 组件时可以使用 .mdx。
组织目录
用文件夹划分主题。每个文件夹可以放置 _category_.json:
{
"label": "使用指南",
"position": 2
}
侧边栏根据目录结构自动生成,无需逐篇添加配置。
常用语法
使用 ## 和 ### 创建章节,使用 - 创建列表。链接可以使用相对路径,例如 [首页](../intro.md)。
示例代码
const message = '开始记录';
console.log(message);
写作提示
优先写清楚文档解决的问题,再提供具体步骤和示例。
图片
将图片放在 static/img/ 下,例如 static/img/example.png,然后使用  引用。
本地预览与构建
运行 npm start 开启实时预览,保存后页面会自动刷新。发布前运行 npm run typecheck 和 npm run build,确认类型检查与文档链接检查通过。