docmd-io/docmd

docmd – 人間と機械のためのドキュメント

何であるか

• プレーンなMarkdownファイルのフォルダを、フル機能の静的ドキュメントサイト および 機械が読み取れるアーティファクトのセットに変換するオープンソースコンパイラ。
• 同じソースは以下の形式で出力されます：
  • HTMLウェブサイト（SPAスタイル、ライト/ダークモード）
  • オフライン検索インデックス（キーワード検索 + オプションのベクトル検索）
  • llms.txt / llms-full.txt – 大規模言語モデル（LLM）に供給するためのプレーンテキストダンプ
  • RAGパイプライン用のオープン知識フォーマット（OKF）バンドル
  • コーディングエージェント用のMCPサーバーインターフェース
  • SEOアセット（サイトマップ、Open Graph、robots.txt）

AI / LLMワークフローにおいて重要な理由

• 現代のドキュメントは、人間、検索エンジン、および検索拡張生成（RAG）を行うAIエージェントの3つの対象を同時に満たす必要がある。
• docmdは1回の処理でこれらのすべての出力を生成し、Markdownソースを唯一の真実のソースとして維持する。
• 本体には RAGを搭載したAIアシスタント が同梱されており、生成された llms.txt コンテキストを使って質問に答えることができる。また、クラウドリレー サービスも提供され、ブラウザに資格情報を露出せずに、任意のLLMプロバイダと通信できる。

主な機能（人間向け）

• ゼロ構成スタート：npx @docmd/core dev で即座にライブプレビューを提供。
• 静的サイト生成（docmd build）は、Vercel、Netlify、Cloudflare Pages、S3など、あらゆる静的ホスティングサービスと互換性がある。
• 内蔵SEO、Open Graph、サイトマップ、バージョン管理、i18n、OpenAPIレンダリング。
• PWAサポート、スレッド付きディスカッション、KaTeXなど、オプションプラグインあり。

主な機能（機械向け）

• AIアシスタント – RAGを介してドキュメントを検索するチャットUI。
• MCPサーバー – docmd mcp で実行されるシンプルなプロトコル。外部のコーディングエージェントがドキュメントを検索・読取・検証できる。
• llms.txt / llms-full.txt – LLMプロンプティング用にすぐに貼り付け可能なコンテキストファイル。
• OKFバンドル – 下流のRAGパイプラインで利用可能な構造化知識パッケージ。
• 意味的検索 – 伝統的なキーワード検索に加えて、オプションのベクトルベースの検索をサポート。

使い方

1. グローバルインストール（npm i -g @docmd/core）または npx/Docker で実行。
2. .md ファイルのフォルダを指定する：

   npx @docmd/core dev   # 開発サーバー
   npx @docmd/core build # 静的出力
   

3. docmd add <plugin> でプラグインを追加（例：pwa、threads）。
4. AI統合のためには、aiコアプラグイン（既に含まれている）をインストールし、クラウドリレーまたは独自のLLMエンドポイントを設定する。

拡張性

• プラグインシステム：コアプラグインでほとんどのニーズを満たす。npmからまたはローカルでカスタムプラグインを追加可能。
• プログラムマティックAPI：import { build } from '@docmd/core' によりCIパイプラインからコンパイラを呼び出せる。
• 設定はオプション。簡単な docmd.config.json でタイトル、サイトURL、ソース/出力ディレクトリなどを設定可能。

コミュニティとライセンス

• コアとプラグインはMITライセンス – 自由に使用・変更・自己ホスティング可能。
• GitHub Discussionsで活発なコミュニティ、パブリックロードマップ、スポンサーオプションあり。
• ドキュメント、移行ガイド（Docusaurus、VitePress、MkDocs、Starlightから）、ライブエディタはすべて docmd.io でホストされている。

結論 docmdは、従来のドキュメントサイトとAI強化ワークフローの新たなニーズを橋渡しする、開発者フレンドリーなツールであり、同じMarkdownソースから読者とLLMの両方にサービスを提供できる。