这个站点使用的是 Docusaurus. 站点内容使用 Markdown 编写,文件都在 docs
文件夹中. 如果只有一些简单的修改,你可以直接在 GitHub 网页端进行修改并新建一个 Pull Request.
在本地开发中,pnpm 被选用为项目的包管理器,你需要使用pnpm安装依赖:
pnpm i
pnpm run start
pnpm run build
pnpm run serve
请注意!请务必在修改后使用 build
和 serve
查看构建产物是否正常输出!
- 关于支持的 Markdown 扩展和在 Markdown 内部使用 Mdx 语法的能力,请参阅 Docusaurus 文档
- 有关编写和维护文档内容的规则和建议,请参阅编写指南。
新增一个章节:
- 克隆此项目
- 在
docs
文件夹中,新增一个文件夹,请语义化命名,假设为test
- 编写内容和
_category_.json
,具体可以借鉴其他文档文件夹 - 创建 Pull Request. 其余事情只需要交给我们来做就好了
编写内容的时候需要注意的事情:
- 中文与英文之间请保留一个空格,如
测试 test 测试