Facebook Docusaurus 中文文档 安装指南

此系列文章的应用示例已发布于 GitHub: docusaurus-docs-Zh_CN. 能够 Fork 帮助改进或 Star 关注更新. 欢迎 Star.

安装指南

Docusaurus 是从全新设计的，易于安装和使用，让您的网站可以快速运行。 要安装 Docusaurus，咱们已经建立了一个简单的脚本，能够为您提供全部的基础架构设置：

1. 进入你将要建立文档的 GitHub repo 目录的根目录。
2. yarn global add docusaurus-init 或 npm install --global docusaurus-init
3. docusaurus-init

除了之前存在的文件和目录，您的根目录如今将包含相似于如下的结构：

root-of-repo
├── 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
│   └── core
│       └── Footer.js
│   └── node_modules
│   └── package.json
│   └── pages
│   └── sidebars.json
│   └── siteConfig.js
│   └── static

若是您不想全局安装 init 脚本，则能够在本地安装，而后经过 npx docusaurus-init 或经过 ./node_modules/.bin/docusaurus-init 建立的 node_modules 目录运行。 运行脚本后，您可能须要删除已建立的 package.json 文件和 node_modules 目录。

此系列文章的应用示例已发布于 GitHub: docusaurus-docs-Zh_CN. 能够 Fork 帮助改进或 Star 关注更新. 欢迎 Star.