为开源项目而生的开源项目——做开源项目的专属伙伴Docusaurus。

介绍
作为程序员都知道有一个叫Github的网站，上面有着成千上万的开源项目，作为开源项目的贡献者们，如果想要获得更多的关注，那么一个好的项目文档或者使用文档无疑是必须的，这样才能让大家更容易的去了解项目本身，以及如何使用，Docusaurus可以为你的开源项目构建一个专属于项目本身的静态文档网站，这一切都变得简单起来!

Github
​​​ https://github.com/facebook/docusaurus​​

作为为开源项目而生的开源项目，docusaurus获得了13k+的stars，受欢迎程度很高！也是一直处于稳步增长趋势！其V2版本也将提上日程，可以到Github上提供意见和反馈!

相关特性
由Markdown提供支持
节省时间并专注于项目的文档。只需使用Markdown 和Docusaurus 编写文档和博客文章，它们就会发布一组静态html文件，可供使用。

使用React构建
通过重用React 扩展或自定义项目的布局。可以在重复使用相同的页眉和页脚的同时扩展文档库。

国际化
本地化已预先配置。使用Crowdin可以将你的文档翻译成70多种语言。

文档版本控制
文档版本控制可帮助你使文档与项目版本保持同步。

文件搜索
使你的社区轻松地在文档中找到他们所需的内容。很轻松的支持Algolia文档搜索。

快速设置
快速启动并运行，而不必担心网站设计。

开发和部署
使用随附的实时服务器进行设计和文档更改。使用脚本或与CircleCI之类的持续集成，将你的网站手动发布到GitHub页面或其他静态文件主机。

网站功能
Docusaurus当前提供支持以帮助你的网站使用翻译，搜索和版本控制，以及一些其他特殊文档markdown特性。如果你有实用功能的想法，可随时在GitHub上贡献力量！

谁正在使用Docusaurus？
Docusaurus正在为这些项目建立网站，其中不乏很多热门的开源项目：

快速开始
Docusaurus从头开始设计，易于安装，可用来快速启动和运行您的网站，Docusaurus创建了一个简单的脚本，它将设置所有基础架构：
1、确保您已安装最新版本的Node。我们还建议您也安装Yarn。
必须Node> = 8.x和Yarn> = 1.5上。
2、创建一个项目（如果不存在），然后将目录更改为该项目的根目录。将在此目录中创建文档。根目录可能包含其他文件。Docusaurus安装脚本将创建两个新目录：docs和website。
通常，现有的或新建的GitHub项目将成为您的Docusaurus站点的位置，但是使用Docusaurus并不是必须的。
3、运行Docusaurus安装脚本：
npx docusaurus-init
如果没有Node 8.2+，或者希望全局安装Docusaurus，请运行yarn global add docusaurus-init或npm install --global docusaurus-init。之后，运行docusaurus-init。
4、验证安装
除了以前存在的文件和目录，根目录现在将包含类似于以下内容的结构：

5、运行示例网站
按照“安装”部分的说明运行Docusaurus初始化脚本docusaurus-init之后，拥有一个可运行的示例网站，作为网站的基础。运行起来：
1、cd website
2、在网站目录中，使用yarn start或npm start运行本地Web服务器。如果尚未自动打开示例站点，则将其加载到本地3000端口。如果已经使用端口3000，则将使用另一个端口。
应该会在Web浏览器中看到示例站点。还有一个LiveReload服务器正在运行，对网站目录中的文档和文件所做的任何更改都将导致页面刷新。会选择随机生成的默认和辅助主题颜色。

6、设置代理
如果在设置代理，则需要针对开发服务器请求将其禁用。可以使用NO_PROXY环境变量来完成。
SET NO_PROXY=localhost
yarn start (or npm run start)
7、更新您的Docusaurus版本
在安装Docusaurus之后的任何时间，都可以通过进入网站目录并键入
yarn outdated docusaurus或npm outdated docusaurus
来检查当前版本的Docusaurus，会看到如下内容：

8、可以通过以下方式更新到最新版本的Docusaurus：
yarn upgrade docusaurus --latest 或者 npm update docusaurus

以上就是入门级别的Docusaurus安装使用方式，详细的安装使用以及发布部署等都可以在官方文档中找到详细的说明，感兴趣的小伙伴可以参阅文档，文档本身就提供了对应的中文版，Enjoy it！

总结
Docusaurus是一个专门为开源项目而生的开源项目文档管理项目，功能丰富，界面美观，可以作为静态文档的构建工具也可以当作博客一样使用它！

更多干货资源请关注作者的专栏。

留言点赞关注，我们一起分享AI学习与发展的干货。