【Facebook】本地机器上安装 docusaurus

 

目录

1. docusaurus 介绍

2. 安装 Docusaurus

2.1 条件

2.2 执行

3. 启动

4. 参考

---

 

1. docusaurus 介绍

 

有一天看到有人用Facebook 的一个快速文档构建工具，原来是这么个玩意，这是啥呢 ？用官网一句话表达：

Docusaurus 使维护开放源代码文档网站变得容易;

用我的话来说：

卧槽，牛逼

这个可以用md 语法写html，而且写了立马就可以生效，感觉有些时候总结文档陈列到上面，有时候还挺实用的;

 

2. 安装 Docusaurus

 

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。

 

老外的官网安装流程;

 

2.1 条件

确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn

Node >= 8.x and Yarn >= 1.5.x

2.2 执行

运行 Docusaurus 的安装脚本:

npx docusaurus-init

如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

3. 启动

cd /User/XXX/docusaurus/website    // 进入到自己的安装目录,自己机器需要改`XXX`

npm start    // 执行node 命令

此时，如果没啥问题的话，脚本会自动打开浏览器: 

http://localhost:3000/

最终结果，如下图所示：

 

 

4. 参考

1. docusaurus;

2. docusaurus.io;