Docusaurus

back、github

相关特性

• 由Markdown提供支持
• 使用React构建
• 国际化
• 文档版本控制
• 文件搜索
• 快速设置
• 开发和部署
  使用随附的实时服务器进行设计和文档更改。使用脚本或与CircleCI之类的持续集成，将你的网站手动发布到GitHub页面或其他静态文件主机
• 网站功能

快速开始

• 确保您已安装最新版本的Node。我们还建议您也安装Yarn。

必须Node> = 8.x和Yarn> = 1.5上。

• 创建一个项目（如果不存在），然后将目录更改为该项目的根目录。将在此目录中创建文档。根目录可能包含其他文件。Docusaurus安装脚本将创建两个新目录：docs和website

通常，现有的或新建的GitHub项目将成为您的Docusaurus站点的位置，但是使用Docusaurus并不是必须的。

• 运行Docusaurus安装脚本：

npx docusaurus-init

如果没有Node 8.2+，或者希望全局安装Docusaurus，请运行yarn global add docusaurus-init或npm install --global docusaurus-init。之后，运行docusaurus-init。

• 验证安装

• 运行示例网站

按照“安装”部分的说明运行Docusaurus初始化脚本docusaurus-init之后，拥有一个可运行的示例网站，作为网站的基础。运行起来：

1、cd website
2、在网站目录中，使用yarn start或npm start运行本地Web服务器。如果尚未自动打开示例站点，则将其加载到本地3000端口。如果已经使用端口3000，则将使用另一个端口。
应该会在Web浏览器中看到示例站点。还有一个LiveReload服务器正在运行，对网站目录中的文档和文件所做的任何更改都将导致页面刷新。会选择随机生成的默认和辅助主题颜色。

• 设置代理

如果在设置代理，则需要针对开发服务器请求将其禁用。可以使用NO_PROXY环境变量来完成。
SET NO_PROXY=localhost

yarn start (or npm run start)

• 更新您的Docusaurus版本

在安装Docusaurus之后的任何时间，都可以通过进入网站目录并键入
yarn outdated docusaurus或npm outdated docusaurus
来检查当前版本的Docusaurus，会看到如下内容：

• 以下方式更新到最新版本的Docusaurus：
  yarn upgrade docusaurus --latest 或者 npm update docusaurus