Facebook Docusaurus 中文文檔 CLI 命令

此係列文章的應用示例已發佈於 GitHub: docusaurus-docs-Zh_CN. 能夠 Fork 幫助改進或 Star 關注更新. 歡迎 Star.

CLI 命令

Docusaurus提供了一組腳原本幫助您生成，運行和部署您的網站。 當使用 Yarn 或 npm 時，能夠用 run 命令調用這些腳本。 一些常見的命令是：

• yarn run start: 從本地服務器構建和運行網站
• yarn run examples: 建立示例配置文件

從命令行運行

腳本可使用 Yarn 或 npm 運行。 若是您已經閱讀了入門指南，您可能已經熟悉 start 命令。 這個命令告訴 Docusaurus 運行生成站點並啓動服務器的 docusaurus-start 腳本，一般這樣調用它：

yarn run start

可使用 npm 來調用相同的腳本：

npm run start

要運行一個特定的腳本，只需將上面例子中的 start 命令替換爲與腳本相關的命令便可。

使用參數

有些命令支持可選參數。 例如，要在端口 8080 上啓動服務器，能夠在運行 start 時指定 --port 參數：

yarn run start --port 8080

若是你使用 npm 運行 Docusaurus，你仍然能夠經過在 npm run <command> 和命令參數之間插入 -- 來使用命令行參數：

npm run start -- --port 8080

配置

這些腳本是做爲安裝過程的一部分在 website/package.json 文件的 "scripts" 鍵下創建的。 若是您須要從新設置，請參考安裝指南。

Docusaurus 提供了一些默認映射，容許您按照 node 慣例運行命令。 每次輸入 docusaurus-start，你均可以輸入 yarn run start 或 npm start 來達到一樣的目的。

命令

• docusaurus-build
• [docusaurus-examples [feature]](#docusaurus-examples-feature)
• docusaurus-publish
• docusaurus-rename-version <currentVersion> <newVersion>
• [docusaurus-start [--port <number>]](#docusaurus-start---port-number)
• docusaurus-version <version>
• docusaurus-write-translations

---

參考

docusaurus-build

別名: build.

生成靜態網站，必要時應用翻譯。 在部署以前用於構建網站。

也能夠參考 docusaurus-start.

---

docusaurus-examples [feature]

別名: examples

若是沒有指定功能，則在您的項目中設置一個最低限度配置的示例網站。這個命令更深刻的內容在 網站準備指南中。指定一個功能 translations 或 versions 來爲該功能生成額外的示例文件。

---

docusaurus-publish

別名: publish-gh-pages

構建，而後將靜態網站部署到 GitHub 頁面。 此命令在 Circle CI 的部署步驟中運行，所以須要定義一些環境變量：

如下一般由用戶在 CircleCI 的 config.yml 文件中手動設置。

• GIT_USER: 與部署提交相關聯的 git 用戶。
• USE_SSH: 是否使用 SSH 而不是 HTTPS 鏈接到 GitHub 倉庫。

示例

GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages

如下是在構建過程當中由 CircleCI 環境 設置的。

• CIRCLE_BRANCH: 與觸發 CI 運行的提交相關聯的 git 分支。
• CI_PULL_REQUEST: 若是當前的 CI 運行是由提交請求中的提交觸發的，那麼預計會實現。

你應該在 siteConfig.js 中分別設置爲 organizationName 和 projectName。 若是它們未在您的站點配置中設置，則會回退到CircleCI環境。

• CIRCLE_PROJECT_USERNAME: 承載git倉庫的 GitHub 用戶名或組織名稱，例如 "facebook"。
• CIRCLE_PROJECT_REPONAME: git repo的名字，例如 "Docusaurus"。

您能夠在發佈指南中瞭解更多關於使用 CircleCI 配置自動部署的信息。

---

docusaurus-rename-version <currentVersion> <newVersion>

別名: rename-version

將文檔的現有版本重命名爲新的版本名稱。

參考 版本化指南 來學習更多.

---

docusaurus-start [--port <number>]

別名: start.

該腳本將構建靜態網站，必要時應用翻譯，而後啓動本地服務器。 該網站將默認從端口 3000 提供。

---

docusaurus-version <version>

別名: version

生成文檔的新版本。 這將致使您的網站的新副本生成並存儲在其本身的版本文件夾中。 用於捕獲映射到特定版本的軟件的 API 文檔的快照。 接受任何字符串做爲版本號。

參考 版本化指南 來學習更多.

---

docusaurus-write-translations

別名: write-translations

將須要翻譯成 website/i18n/en.json 文件的字符串寫入英文。 腳本將遍歷 website/pages/en 中的每一個文件，並經過 siteConfig.js 文件和其餘配置文件讀取英文字符串，而後在 Crowdin 上進行翻譯。 請參閱翻譯指南瞭解更多信息。

若是這篇文章對您有幫助, 感謝 下方點贊 或 Star GitHub: docusaurus-docs-Zh_CN 支持, 謝謝.