ドキュメントを作成する

docStatic では、「トピック」と呼ばれるファイルに Markdown でコンテンツを記述します。通常は各トピックを自分で作成しますが、特定の種類のドキュメントでは自動生成されるトピックもあります。

注意

GraphQL および OpenAPI のドキュメントは、サーバーまたはスキーマから自動生成されます。

トピックを作成するには：

1. Topics コレクションから Add File をクリックします。
2. トピックに Title を付けます。
3. （オプション）コンテキストセンシティブヘルプでこのトピックを使用したい場合は、Slug を設定します。これは /docs/ からの固定パスです。
4. トピックに Description を付けます。これは Doc Card List に表示されます。
5. （オプション）必要なタクソノミーの Tags を追加します。
6. （オプション）Conditions を設定します。
7. ワークフローステータスが Draft に設定されていることを確認します。
8. コンテンツを入力します。
9. Save をクリックします。

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

すべてのトピックの先頭には、2組の3つのハイフン（---）の間に含まれる YAML セクションがあります。docStatic はこれを以下のような用途に使用します：

• 条件付きテキスト
• タクソノミー（ドキュメントタグ）
• ワークフロー

詳細については、Docusaurus ドキュメントの Create a doc を参照してください。