Facebook Docusaurus 中文文檔 建立網站

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

建立網站

Docusaurus 的創造，是但願可以讓你爲開源項目建立一個網站和文檔變得很是簡單。

在 安裝 和 準備 以後，爲文檔建立基本網站的許多工做已經完成。

網站結構

你的網站結構看起來像下面這樣：

root-of-repo
├── docs
└── website
│   └── blog
│   └── core
│       └── Footer.js
│   └── node_modules
│   └── package.json
│   └── pages
│   └── sidebars.json
│   └── siteConfig.js
│   └── static

這裏假設您已經刪除了與 初始化 腳本一塊兒安裝的 .md 示例文件。

全部的文檔文件都應該做爲 .md 文件放在 docs 文件夾中。 任何博客文章都應該在 blog 文件夾中。

博客帖子的格式必須爲 yyyy-mm-dd-your-file-name.md

建立您的基本網站

要建立一個功能齊全的網站，您只須要執行幾個步驟：

1. 將您的文檔以 .md 文件的形式添加到 /docs 文件夾中，並確保每一個文件都有正確的header。 最簡單的標題以下，其中 id 是連接名稱（例如 docs/intro.html），title 固然是瀏覽器頁面的標題。

   ---
   id: intro
   title: 入門
   ---
   
   這是個人 *新文件內容* ...

2. 將零個或多個文檔添加到 sidebars.json 文件，以便您的文檔在側邊欄中呈現，若是您想要顯示它們。

   若是您不將文檔添加到 sidebars.json 文件中，那麼文檔依然被渲染，但只能從其餘文檔連接到該文檔，並使用已知的URL進行訪問。

3. 修改 website/siteConfig.js 文件來配置網站，按照 website/siteConfig.js 的 文檔 指引。
4. 建立任何的 自定義頁面 和/或 自定義 website/core/Footer.js 文件來爲你的網站提供頁腳。
5. 將網站資源（如圖像）放在 website/static/ 文件夾中。

6. 運行該網站以查看更改的結果。

   cd website
   yarn run start # 或 `npm run start`
   # 瀏覽 http://localhost:3000

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