文件說明引言

文件說明功能提供使用者一種方式，使用階層式格式組織 Markdown 檔案。

資訊

查看Docs 外掛程式應用程式介面參考文件以取得完整的選項清單。

您的網站文件說明以四個層級組織，從最低到最高

1. 個別頁面。
2. 側邊欄。
3. 版本。
4. 外掛程式執行個體。

這份指南將依序介紹它們：從如何設定個別頁面開始，接著介紹如何建立一個或多個側邊欄，再介紹如何建立和管理版本，最後介紹如何使用多個文件說明外掛程式執行個體。

僅文件模式

一個新初始化的 Docusaurus 站台有下列結構

example.com/                                -> generated from `src/pages/index.js`

example.com/docs/intro                      -> generated from `docs/intro.md`
example.com/docs/tutorial-basics/...        -> generated from `docs/tutorial-basics/...`
...

example.com/blog/2021/08/26/welcome         -> generated from `blog/2021-08-26-welcome/index.md`
example.com/blog/2021/08/01/mdx-blog-post   -> generated from `blog/2021-08-01-mdx-blog-post.mdx`
...

所有文件會放置於子路由 docs/ 下。但如果你的網站僅有文件呢？或者你想優先顯示你的文件，將它們放在根目錄下呢？

假設在你的設定檔中有下列內容

docusaurus.config.js

export default {
  // ...
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          /* docs plugin options */
        },
        blog: {
          /* blog plugin options */
        },
        // ...
      },
    ],
  ],
};

要進入僅文件模式，請它改成像這樣

docusaurus.config.js

export default {
  // ...
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          routeBasePath: '/', // Serve the docs at the site's root
          /* other docs plugin options */
        },
        blog: false, // Optional: disable the blog plugin
        // ...
      },
    ],
  ],
};

請注意，你不一定要放棄使用部落格或其他外掛程式。routeBasePath: '/' 的作用只是將文件從 https://example.com/docs/some-doc 移至網站根目錄：https://example.com/some-doc。如果啟用部落格，仍可透過子路由 blog/ 存取。

別忘了透過新增frontmatter在根目錄（https://example.com/）中放入一些頁面

docs/intro.md

---
slug: /
---

This page will be the home page when users visit https://example.com/.

警告

如果你新增 slug: / 到文件，使其成為首頁，你應刪除位於 ./src/pages/index.js 的現有首頁，否則會有兩個檔案對應到相同的路由！

現在，網站的結構會變如下

example.com/                       -> generated from `docs/intro.md`
example.com/tutorial-basics/...    -> generated from `docs/tutorial-basics/...`
...

提示

對於只想使用 Docusaurus 的部落格功能的人來說，也有一個「僅部落格模式」。你可以使用上述相同的詳細方法。請遵循 「僅部落格模式」 上的設定說明。