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

はじめに

docStaticは、ライターと開発者の間の溝を埋め、ユーザーが愛するオンラインドキュメントの作成を支援するモダンなドキュメントプラットフォームです。

オンラインドキュメント向けのコンポーネントコンテンツ管理システムとdocs-as-codeソリューションの優れた機能を同時に提供します。docStaticを使用すると、チームの誰もが開発者のワークフローを犠牲にすることなくドキュメントの作成・編集ができます。

機能​

docStaticはTinasaurusを改良したものとして始まりました。Tinasaurusは、静的サイトジェネレーター（Docusaurus）とヘッドレスコンテンツ管理システム（TinaCMS）を組み合わせたオープンソースのReactベースのプロジェクトです。以下が含まれます。

  • Markdown、MDX、JSON、YAMLコンテンツの使いやすい編集インターフェース
  • 既存のGitおよびCI/CDワークフローとの統合
  • リッチなコンテンツオーサリングのための埋め込みMDXコンポーネント
  • サードパーティメディアプロバイダーをサポートするメディアマネージャー
  • クラウドでの編集（ローカルセットアップ不要）
  • コンテンツの状態とリンクの健全性を報告するダッシュボード
  • AIアシスタント統合のためのModel Context Protocol（MCP）サーバー
  • ドキュメントに関する質問に答えるオプションのブラウザ内AIチャットボット

簡単なコンテンツ管理​

docStaticのデフォルトコレクションには、CCMSに期待されるより高度なオーサリング機能のいくつかが含まれています。

リッチテキストエディターを使用すると、以下を簡単に追加できます。

  • コンテンツ再利用のための条件付きテキスト、スニペット、変数セット、一元管理されたURL。
  • タクソノミー。
  • 用語集の用語。
  • コードブロック、コメント、折りたたみ可能な詳細、図、脚注、タブ。これらはコンテンツファイルに挿入できるテンプレートとして利用可能です。

CMSはGraphQLスキーマを使用して、コンテンツの構造をコレクションのセットとして記述します。

ダッシュボード​

docStaticはTinaCMSにダッシュボード機能を追加し、GraphQL APIに問い合わせてコンテンツの状態とリンクの健全性をCMS内で直接報告します。これには、各トピックのワークフローステータスを示すコンテンツ概要と、外部リンクをチェックして無効なリンクを検出するリンク健全性ダッシュボードが含まれます。

Gitバックエンド​

ソースコントロール、自動化、オプションで公開はGitHubを通じて管理されます。リッチテキストエディターでファイルを編集する場合、TinaCMSは保存時にコミットするか、ローカルで作業している場合はファイルに直接保存します。Gitはチーム全体の唯一の信頼できる情報源のままです。

リポジトリ構造はDocusaurusのデフォルトと非常に似ていますが、TinaCMSとの統合に必要な変更がいくつかあります。

事前設定済みプラグイン​

docStaticは、KaTeX数式、Lunr検索、Mermaidダイアグラム、OpenAPIドキュメントなどの機能をサポートするプラグインが事前設定されています。国際化（i18n）の組み込みサポートがあります。多言語のスペル、文法、オプションのスタイルチェックは、ブラウザおよびIDEプラグインを通じてLanguageToolによって提供されます。

AI統合​

docStaticには統合されたModel Context Protocol（MCP）サーバーが含まれており、AIアシスタントがドキュメントに直接アクセスして理解できるようにします。これにより、実際のドキュメント構造とコンテンツに基づいたコンテンツ編集、検索、分析のためのインテリジェントなサポートが提供されます。

docStaticは、公開サイトにオプションのAIチャットボットを追加することもできます。これにより、訪問者は質問をして、ドキュメントに基づいた回答を得ることができます。デフォルトでは訪問者のブラウザ内で完全に動作するため、外部サービス、APIキー、サーバーは不要ですが、自分でホストする有料プロバイダーを指定することもできます。

Reactベース​

コンテンツはMDX形式で保存されます。MDXはMarkdownの拡張で、注記などの機能のためのカスタムReactコンポーネントをサポートします。これらのコンポーネントはユニバーサルに利用可能で、個々のファイルで宣言する必要はありません。ローカルで作業する場合、開発サーバーは変更を保存するとすぐにページを再コンパイルします。

完全なドキュメント化​

開発者は、DocusaurusとTinaCMSのドキュメントでdocStaticの設定と使用開始に必要なすべての情報を見つけられます。情報が古くなる可能性を避けるため、その情報はここには重複して記載していません。代わりに、docStaticのドキュメントはCMSの使用に焦点を当てています。