爱速搭文档

文档基于 https://docusaurus.io/ 编译

本地预览

yarn install
yarn start

创建或新增文档

创建或删除文档除了要在 docs 下面新增对应 md 文件外，需要修改 sidebars.js 文件，这个是文档目录

编写文档

话术规范

• 多章节写作，分为：概述、前置条件、注意事项、常见问题、相关 API 等
• 句子采用动宾结构，例如：创建流程
• 最后一步必须要给出能够查看的结果

章节标题

文档名称作为一级标题，内容中的目录要从二级标题开始，即 ##标题

引用图片

需要的图片全部存放到 static/img 目录，以文档的路径为图片文件夹路径，存放后，文档内容可以直接引用，引用时，只写/img/xxx/xx/xx.png 路径即可访问。

引用文档

文档间的跳转链接使用相对地址，比如 [私有部署安装](../私有部署/私有部署安装)