介绍

项目的说明文档是非常重要的。

Docusaurus 可以快速搭建文档网站，支持 Markdown、基于 React、对翻译友好等。

安装使用

参考 https://docusaurus.io/docs/en/installation

安装

npm install --global docusaurus-init

在项目下

docusaurus-init

自动生成文件结构

root-directory
├── docs-examples-from-docusaurus
│   ├── doc1.md
│   ├── doc2.md
│   ├── doc3.md
│   ├── exampledoc4.md
│   └── exampledoc5.md
└── website
    ├── blog-examples-from-docusaurus
    │   ├── 2016-03-11-blog-post.md
    │   ├── 2017-04-10-blog-post-two.md
    │   ├── 2017-09-25-testing-rss.md
    │   ├── 2017-09-26-adding-rss.md
    │   └── 2017-10-24-new-version-1.0.0.md
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

运行

按以下步骤修改运行

1. 重命名 docs-examples-from-docusaurus 为 docs
2. cd website
3. 重命名 blog-examples-from-docusaurus 为 blog
4. npm start
5. 访问 http://localhost:3000

升级

npm update docusaurus