Advanced guides
This section covers the more advanced features of docStatic including integrations:
Front Matter CMS
VSCodium などの IDE でコンテンツを作成する場合、CMS が提供する機能は利用できません。一般的なワークフローでは、開発者が IDE で MDX ファイルを直接編集してコンテンツを作成・編集し、ライターが CMS でコンテンツを整理してタグ付けします。開発者が最終更新日の記載を忘れた場合、その情報を取得するにはファイルのプロパティを確認する必要があります。ただし、Front Matter というプラグインとして利用できる軽量 CMS があります。docStatic リポジトリには Front Matter の設定例が含まれています。詳細については、Front Matter のドキュメントを参照してください。
ホステッドCMS
1項目
Notifications
docStatic はワークフロー通知の送信に GitHub Actions を使用しています。レビューと翻訳の通知例は .github/workflows/ フォルダに含まれています。これらを有効にするには、GitHub での設定が必要です。また、独自のカスタム通知を開発するための出発点としても使用できます。
MCP Server Integration
1項目
OpenAPI reference docs
docStatic は docusaurus-plugin-openapi-docs を使用して、OpenAPI 仕様から API リファレンスドキュメントを生成します。このプラグインは仕様ファイルを読み込み、docs/ ツリー内に一連の MDX ファイルを書き込みます。Docusaurus はそれらを通常のページとしてビルドします。
Style checking
ドキュメント・アズ・コードで作業するライターが最も恋しく思う機能の1つが、優れたスペル・文法・スタイルチェッカーです。デフォルトでは、スペルチェックはウェブブラウザや統合開発環境によって提供されます。シンプルなウェブサイトには十分かもしれませんが、より高度なものが必要な場合は専用の文法チェッカーが必要です。
Developers who are interested in extending the functionality of docStatic should refer to the Guides and Advanced Guides in the Docusaurus documentation.