这个站点使用的是 Fumadocs 程序。站点内容使用 MDX 编写,文档文件在 /content/docs 文件夹中。如果只有一些简单的修改,你可以直接在 GitHub 网页端进行修改并新建一个 Pull Request.

在本地开发中,pnpm 被选用为项目的包管理器,你需要使用 pnpm 安装依赖:

 pnpm install
 pnpm dev
 pnpm build

• 关于支持的 MDX 扩展和在 MDX 内部使用 React 语法的能力,请参阅 Fumadocs 文档
• 有关编写和维护文档内容的规则和建议,请参阅编写指南。

新增一个章节:

1. 克隆此项目
2. 在 content/docs 文件夹中,新增一个文件夹,请语义化命名,假设为 test
3. 编写内容,具体可以借鉴其他文档文件夹,请务必设置了父文件夹的 meta.json 文件,具体请参考 Fumadocs 文档
4. 创建 Pull Request. 其余审核的事情只需要交给我们来做就好了

编写内容的时候需要注意的事情:

1. 中文与英文之间请保留一个空格,如测试 test 测试,可以使用 AutoCorrect 进行检查和修改

Docs © Mix Space Team, Released under MIT. Created on Nov 2, 2024