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

ドキュメントの作成

Markdownファイル（`greeting.md`）を作成し、`docs`ディレクトリに配置します。

website # root directory of your site
├── docs
│   └── greeting.md
├── src
│   └── pages
├── docusaurus.config.js
├── ...
---
description: Create a doc page with rich content.
---

# Hello from Docusaurus

Are you ready to create the documentation site for your open source project?

## Headers

will show up on the table of contents on the upper right

So that your users will know what this page is all about without scrolling down or even without reading too much.

## Only h2 and h3 will be in the TOC by default.

You can configure the TOC heading levels either per-document or in the theme configuration.

The headers are well-spaced so that the hierarchy is clear.

- lists will help you
- present the key points
- that you want your users to remember
  - and you may nest them
    - multiple times
注記

`docs`ディレクトリの下にあるアンダースコア（`_`）で始まるすべてのファイルは、「部分的な」ページとして扱われ、デフォルトでは無視されます。

部分ページのインポートについて詳しくは、こちらをご覧ください。

ドキュメントのフロントマター​

フロントマターは、ドキュメントページに追加のメタデータを提供するために使用されます。フロントマターはオプションです。Docusaurusは、フロントマターなしでも必要なメタデータすべてを推測できます。たとえば、以下で紹介するドキュメントタグ機能は、フロントマターの使用が必要です。すべての可能なフィールドについては、APIドキュメントを参照してください。

ドキュメントタグ​

タグはフロントマターで宣言され、ドキュメントのサイドバーに加えて、別の分類の次元を導入します。

タグをインラインで定義するか、`tags file`（オプション、通常は`docs/tags.yml`）で宣言された定義済みのタグを参照することができます。

次の例では

  • `docusaurus`は`docs/tags.yml`で宣言された定義済みのタグキーを参照しています。
  • `Releases`は、`docs/tags.yml`に存在しないため、インラインタグです。
docs/my-doc.md
---
tags:
  - Releases
  - docusaurus
---

# Title

Content
docs/tags.yml
docusaurus:
  label: 'Docusaurus'
  permalink: '/docusaurus'
  description: 'Docs related to the Docusaurus framework'
ヒント

タグは`tags: [Demo, Getting started]`のように宣言することもできます。

可能なすべてのYaml配列構文については、こちらをご覧ください。

フォルダ構造の整理​

Markdownファイルが`docs`フォルダにどのように配置されるかは、Docusaurusのコンテンツ生成に複数の影響を与える可能性があります。しかし、それらのほとんどはファイル構造から切り離すことができます。

ドキュメントID​

すべてのドキュメントには一意の`id`があります。デフォルトでは、ドキュメントの`id`は、ルートdocsディレクトリを基準としたドキュメントの名前（拡張子なし）です。

たとえば、`greeting.md`のIDは`greeting`、`guide/hello.md`のIDは`guide/hello`です。

website # Root directory of your site
└── docs
   ├── greeting.md
   └── guide
      └── hello.md

ただし、`id`の**最後の部分**は、フロントマターでユーザーが定義できます。たとえば、`guide/hello.md`の内容が以下のように定義されている場合、最終的な`id`は`guide/part1`になります。

---
id: part1
---

Lorem ipsum

IDは、サイドバーを手書きする場合、またはドキュメント関連のレイアウトコンポーネントやフックを使用する場合に、ドキュメントを参照するために使用されます。

ドキュメントURL​

デフォルトでは、ドキュメントのURLの場所は、`docs`フォルダを基準としたファイルパスです（いくつかの例外を除く）。つまり、ファイル名が以下のいずれかの場合、ファイル名はURLに含まれません。

  • `index`として命名（大文字と小文字を区別しない）：`docs/Guides/index.md`
  • `README`として命名（大文字と小文字を区別しない）：`docs/Guides/README.mdx`
  • 親フォルダと同じ名前：`docs/Guides/Guides.md`

いずれの場合も、デフォルトのスラッグは` /Guides`のみで、` /index`、` /README`、または重複する` /Guides`セグメントは含まれません。

注記

この規則は、カテゴリインデックス規則とまったく同じです。ただし、`isCategoryIndex`設定はドキュメントのURLには影響しません。

フロントマターの`slug`を使用して、ドキュメントのURLを変更します。

たとえば、サイト構造が次のようになっているとします。

website # Root directory of your site
└── docs
    └── guide
        └── hello.md

デフォルトでは`hello.md`は` /docs/guide/hello`で利用できます。URLの場所を` /docs/bonjour`に変更できます。

---
slug: /bonjour
---

Lorem ipsum

`slug`は、docプラグインの`routeBasePath`（デフォルトでは` /docs`）に追加されます。URLから` /docs`部分を削除する方法については、ドキュメントのみモードを参照してください。

注記

使用できます

  • 絶対スラッグ：`slug: /mySlug`、`slug: /`…
  • 相対スラッグ：`slug: mySlug`、`slug: ./../mySlug`…

ルートでドキュメントを使用可能にし、`https://docusaurus.dokyumento.jp/docs/`のようなパスを持つ場合は、slugフロントマターを使用できます。

---
id: my-home-doc
slug: /
---

Lorem ipsum

自動生成されたサイドバーを使用する場合、ファイル構造によってサイドバー構造が決まります。

ファイルシステムの構成に関する推奨事項は、ファイルシステムをサイドバー構造にミラーリングすること（そのため、`sidebars.js`ファイルを手で記述する必要はありません）、そして各ドキュメントのURLをカスタマイズするために`slug`フロントマターを使用することです。