Typemark Documentation

ナビゲーション

タブ、グループ、ページでサイドバーを整理し、どのページを公開するかを決めます。

2026年11月19日更新

typemark.json の navigation キーは、サイトで公開するページと、その表示順を決めます。navigation に記載されていないページは公開されません。

構造

navigation は、タブ、グループ、ページの3階層で構成されます。

"navigation": {
  "tabs": [
    {
      "tab": "Documentation",
      "groups": [
        { "group": "Getting started", "pages": ["introduction", "quickstart"] },
        { "group": "Guides", "pages": ["guides/authentication", "guides/deployment"] }
      ]
    }
  ]
}
  • タブ はサイトをセクションに分けます。タブが2つ以上ある場合、サイトのヘッダーに表示され、サイドバーにはアクティブなタブのグループが表示されます。
  • グループ はサイドバーの見出し付きセクションです。公開ページがないグループは除外されます。
  • ページ はファイルへの参照で、記載された順に表示されます。

ページの参照

pages の各エントリは、拡張子を除いたファイルパスです。Typemark は .mdx を先に探し、次に .md を探します。

参照ファイル
"introduction"introduction.mdx または introduction.md
"guides/authentication"guides/authentication.mdx または guides/authentication.md

この参照はページの URL パスにもなります。guides/authentication は /guides/authentication で公開されます。

ページがサブフォルダにある場合は、docs_root を設定すると、参照はそのフォルダ内で解決されます。

公開される内容

  • リストに載っているページ は公開され、サイドバーに表示され、navigation の順序に従って前へ・次へのリンクが付きます。
  • navigation にないファイル は公開されません。サイトに載せるには、グループに追加してください。
  • 最初のタブの最初のグループの最初のページ がランディングページになります。
  • 翻訳 はリストに載りません。fr/quickstart.mdx のようなページの翻訳は、同じ場所の navigation でページと一緒に公開されます。詳しくは 言語 を参照してください。

ページをリストから外すには、フロントマターに hidden: true を追加します。そのページは URL では引き続き開けますが、サイドバー、前へ・次へのリンク、検索、サイトマップ、llms.txt、llms-full.txt、MCP サーバー からは除外され、noindex タグが付きます。最初のページを hidden にした場合、ランディングページはリストに載っている最初のページになります。

複数のタブ

"navigation": {
  "tabs": [
    {
      "tab": "Documentation",
      "groups": [
        { "group": "Getting started", "pages": ["introduction", "quickstart"] }
      ]
    },
    {
      "tab": "Changelog",
      "groups": [
        { "group": "Releases", "pages": ["changelog/v2", "changelog/v1"] }
      ]
    }
  ]
}

OpenAPI 仕様からの API リファレンス

OpenAPI 仕様(JSON または YAML)から API ページを生成するには、ページ参照の代わりに source オブジェクトを使います。

{
  "group": "Endpoints",
  "pages": [
    "api-reference/overview",
    { "source": "api-reference/openapi.json" }
  ]
}

Typemark は、そのグループに概要ページを生成し、エンドポイントごとに1ページを生成します。これらはエンドポイントの最初のタグごとにサイドバーでグループ化されます。source のパスはリポジトリのルートからの相対パスです。設定 > API リファレンス で仕様をアップロードすることもでき、その場合はエントリが自動的に追加されます。

エディターのサイドバーにある Navigation タブを開きます。ページをドラッグして並べ替えたり、グループ間で移動したりできます。グループの追加、名前変更、削除も可能です。変更は typemark.json に直接保存されます。

グループを削除すると、そのページは navigation から外れ、サイトからも非表示になります。ファイル自体はリポジトリに残ります。

pages 配列を編集します。配列内の順序が、サイドバーでの表示順になります。

"pages": ["quickstart", "introduction"]

エディターで作成した新しいページは、自動的に navigation に追加されます。