メインコンテンツまでスキップ

ドキュメントの作成

ドキュメントは、各ページをグループにまとめて、繋げたものです。ここで、ドキュメントにすると使えるものを紹介します。

  • サイドバーからページを選択可能に
  • 戻る/進むボタンで読み進められるように
  • バージョン管理

ドキュメント化の手順​

このページ、すなわちdocs/中枢向け情報/ドキュメントの作成.mdを作ることを考えます。

docs/中枢向け情報/ドキュメントの作成.md
---
sidebar_position: 2
---

# ドキュメントの作成

このとき、サイドバーの見出しは、`#`1 つから始まる大見出し(今回なら"ドキュメントの作成")になります。

sidebar_positionが増えたことに注意してください。これは、"このフォルダ内において、このページは何番目に表示されるか"を意味します。

今回の場合、2 番目です。ちなみに、1 番目は"ページの作成"ページでした。

サイドバーとグループ化​

先述した通り、サイドバーに表示される順番はsidebar_positionの番号順、サイドバーに表示される見出しは#1 つから始まる大見出しになります。

ここで、sidebar_positionの番号は連番である必要はありません。例えば、このページのsidebar_positionを100に設定することも可能です。

また、ドキュメントをグループ分けすることもできます。例えば、このページは「運営中枢向け情報」というグループに入っています。これは、以下のようにして作ります。

  1. フォルダを作ります。名前は分かればなんでも構いません。
  2. フォルダ内に、同じグループに入れたいページのファイルを全て入れます。
  3. フォルダ内に、_category.jsonを作ります。内容は以下のようにします。
_category.json
{
"label": "グループの名称",
"position": [任意の整数 sidebar_position と同じ感じです],
"link": {
"type": "generated-index",
"description": "ここにはグループの説明を入れます。"
}
}

これで、各ページをまとめたグループが完成し、ドキュメントとして整理した形にすることができます。

サイドバーを手動でカスタムする方法もありますが、ここでは割愛します。