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.