ドキュメントDocumentationContributingAdding new docs

新しいドキュメントの追加

ドキュメントサイトとブログに新しい文書を追加します。

ドキュメントの場合

  1. apps/content/docs/[language] フォルダーに新しい .mdx ファイルを作成し、文書の内容を記述します。
  2. サイトのナビゲーションメニューに文書を追加します。 これを行うには、src/config/docs.ts ファイルの sidebarNav プロパティに、必要な情報を持つ新しい項目を追加します。既存項目のパターンに従ってください。これにより、その文書は検索コマンドパレットにも追加されます。

MDX ドキュメント設定

MDX ドキュメントは apps/content/docs/[language] と apps/content/blog/[language] フォルダーに保存されます。各ドキュメントは MDX ファイルで、タイトルや説明などのメタデータを含むヘッダーを持ちます。以下はドキュメントヘッダーの例です。

---
title: Document Title
description: Document Description.
sort: 1
---

次のメタデータフィールドに対応しています。

  • title（必須）: ドキュメントのタイトル。
  • description（必須）: ドキュメントの短い説明。
  • sort（任意）: ナビゲーション内でのドキュメント順序を決める数値。値が小さいドキュメントほど先に表示されます。指定しない場合、ドキュメントはタイトルのアルファベット順で並びます。
  • links（任意）: 関連ドキュメント、API リファレンス、ソースコードなどへのリンク。
  • toc（任意）: 目次を表示するかどうか。既定値は true です。

ドキュメントに新しいメタデータを追加するには、ヘッダーへ新しいキーを追加できます。たとえば、文書の著者を示す author キーを追加できます。

---
title: Document Title
description: Document Description.
sort: 2
author: Author Name
---

ただし、カスタムメタデータを追加する場合は、プロジェクトルートにある contentlayer.config.ts ファイルの Doc または Blog 定数内、fields プロパティも更新する必要があります。 その後、ドキュメントテンプレートに新しい情報を表示する必要があります。これには src/app/[locale]/docs/[[...slug]]/page.tsx ファイル、または src/app/[locale]/blog/[[...slug]]/page.tsx ファイル、もしくはその子コンポーネントのいずれかを更新します。

Contentlayer の再構築

ドキュメントコンテンツを変更したり、新しいドキュメントを追加したり、contentlayer.config.ts ファイルを変更したりした場合、開発中に変更を反映するには contentlayer キャッシュを再構築する必要があります。次を実行してください。

cd apps/web
pnpm contentlayer:build

このコマンドは、アプリケーションに必要なコンテンツ型とデータを再生成します。次のような場合は、このコマンドを実行する必要があります。

  • contentlayer.config.ts ファイルへ新しいメタデータフィールドを追加した場合
  • 開発サーバーが起動していない状態で MDX コンテンツを追加または変更した場合
  • コンテンツ構成の構造を変更した場合

本番用にプロジェクトをビルドするときはこのコマンドが自動的に実行されますが、開発中にコンテンツの構造変更を行った場合は手動で実行してください。

IntroductionCode