project-with-docs

为了规范化每个项目的文档,创建了project-with-docs这个仓库,新创建的项目可以选择使用这个模板。模板本身也需要不断完善。

文档

请熟悉[docusaurus]后再进行文档的修改和部署

  1. 已部署的文档位于gh-pages分支 请不要修改gh-pages分支的任何内容,因为都是由yarn deploy命令生成的。

  2. 先在本地yarn start确定无异常情况后deploy

文档修改部署

cd docs

打开docusaurus.config.js

  1. 用搜索将 Project Name 换成项目名称。

  2. 用搜索将 project-with-docs 换成repo名称。

Need Help (TODO)

目前,文档的目录结构并不完善,仍用docusaurus的template。如果你使用这个template完成了一个完整的项目,请借鉴你的文档结构完善这个template。


Document link

Github link