Facebook Docusaurus 中文文檔

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

Docusaurus ·

此項目同步自 facebook / Docusaurus 項目中的 docs. 除特殊狀況, 將保持每個月一次的同步頻率.

Docusaurus 是一個輕鬆構建，部署和維護開源項目的網站項目。

• 快速起步 Docusaurus 的構建很容易，在儘量短的時間內 開始並運行 。咱們已經打造了 Docusaurus 來處理網站構建過程，以便您能夠專一於您的項目。
• 本地化 Docusaurus 經過 CrowdIn 提供 本地化支持。經過翻譯文檔來加強您的國際社區的地位。
• 可定製 雖然 Docusaurus 帶有您須要開始的關鍵頁面和部分，包括主頁，文檔部分，博客和其餘支持頁面，但它也是可定製的，以確保您擁有一個獨一無二的網站。

安裝

Docusaurus 做爲 npm 上的 docusaurus 包 來提供。

咱們還發布了 docusaurus-init 包 ，來使 Docusaurus 的 入門 更加簡單。

文檔目錄

• 入門

  • 安裝指南
  • 準備網站
  • 建立網站
  • 發佈網站

• 指南

  • 添加博客
  • 自定義頁面
  • 啓用搜索
  • 導航和側邊欄
  • 翻譯 & 本地化
  • 版本化

• API

  • CLI 命令
  • Markdown 功能
  • 頁面和樣式
  • siteConfig.js

貢獻

咱們發佈了 Docusaurus，由於它能夠幫助咱們更好地擴展和支持 Facebook 上的許多 OSS 項目。 咱們但願其餘組織也能從這個項目中受益。 咱們感謝社區的任何貢獻。

行爲守則

Facebook 已經採用了咱們指望項目參與者遵照的行爲準則。 請閱讀全文 ，以便了解哪些行爲是不會容忍的。

貢獻指南

閱讀咱們的貢獻指南 ，瞭解咱們的開發過程，如何提出錯誤修正和改進，以及如何構建和測試您對 Docusaurus 的更改。

面向初學者友好的 Bugs

爲了幫助您理解咱們的貢獻過程，咱們列出了一些面向初學者友好的 Bugs，這些 Bugs包含的錯誤至關容易修復。 這是一個開始的好地方。

許可協議

Docusaurus 採用 MIT 許可協議.

而 Docusaurus 文檔 (例如, /docs 目錄下的 .md 文件) 採用 Creative Commons 許可協議.

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