メインコンテンツへスキップ
バージョン: 3.5.2

ドキュメントの概要

ドキュメント機能は、Markdownファイルを階層形式で整理する方法をユーザーに提供します。

情報

オプションの完全なリストについては、ドキュメントプラグイン API リファレンスドキュメントを確認してください。

サイトのドキュメントは、次の低いレベルから高いレベルまで4つのレベルで構成されています

  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/ サブルートから引き続きアクセスできることに注意してください。ブログの使用を必ずしも諦める必要はありません。あるいは他のプラグインも同様です。

フロントマターを追加して、ルート (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 にある既存のホームページを削除する必要があります。そうしないと、同じルートにマップされるファイルが2つできてしまいます。

これで、サイトの構造は次のようになります

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

Docusaurusのブログ機能のみを使用したい人のために、「ブログのみモード」もあります。上記で説明したのと同じ方法を使用できます。 ブログのみモードのセットアップ手順に従ってください。