docmd-io/docmd

人間と機械のためのドキュメント。
ひとつの Markdown ソース → ウェブサイト、検索、AI コンテキスト、エージェント、ナレッジフォーマット。

ウェブサイト  ·  ドキュメント  ·  Cloud Relay  ·  ライブエディタ  ·  Agent Skills  ·  Issues

クイックスタート

Markdown ファイルが含まれるフォルダを docmd に指定して実行します:

npx @docmd/core dev

http://localhost:3000 を開きます。

これだけです。ファイル構造からナビゲーションが自動生成されます。設定ファイル、フロントマター、フレームワークの学習は不要です。

デプロイの準備ができたら:

npx @docmd/core build

docmd は、Vercel、Cloudflare Pages、Netlify、GitHub Pages、S3、NGINX、Caddy など、あらゆる静的ホストにデプロイ可能な静的サイトを生成します。

Node.js 20+ が必要です。

npm install -g @docmd/core

# または
pnpm add -g @docmd/core

docmd dev
docmd build

docker run -p 3000:3000 ghcr.io/docmd-io/docmd:latest

ひとつのソース、あらゆる出力形式

docmd はオープンソースのドキュメントコンパイラです。

Markdown を単なるウェブサイトの入力として扱うのではなく、docmd は同じソースを読者、検索エンジン、LLM、コーディングエージェント、ナレッジシステム向けの出力へとコンパイルします。

Markdown
   │
   ▼
 docmd
   │
   ├── → 静的ドキュメントサイト
   ├── → オフライン検索インデックス
   ├── → llms.txt / llms-full.txt
   ├── → Open Knowledge Format (OKF)
   ├── → サイトマップ + SEO メタデータ
   ├── → robots.txt + Open Graph
   ├── → AI エージェント用 MCP インターフェース
   └── → AI アシスタント用コンテキスト

ひとつのソースツリー、ひとつのビルドパイプライン。ドキュメント用と AI ナレッジ用に別々のスタックを保守する必要はありません。

なぜ docmd なのか？

現代のドキュメントには、複数の異なる読者が存在します。

人間には高速でナビゲートしやすいウェブサイトが必要です。検索エンジンには構造化メタデータが必要です。LLM にはクリーンなコンテキストが必要です。コーディングエージェントにはツールとプロトコルが必要です。RAG システムには構造化された知識が必要です。

docmd は、Markdown を中心に据えたまま、これらすべてを同時に構築します。

主な機能

設定不要、即座にスタート

任意の Markdown フォルダを指定するだけで docmd が起動します。ファイル構造からナビゲーションが自動生成されるため、ボイラープレート、フロントマター、ビルドパイプラインの準備なしですぐに開始できます。

デフォルトで軽量、どこでも高速

docmd は最小限のバニラ JavaScript と高速な SPA スタイルのナビゲーションを備えた静的 HTML を生成します。オフライン全文検索、サイトマップ、カノニカル URL、Open Graph メタデータなどの必需機能が出力に含まれています。

AI およびエージェント対応

docmd は、機械可読なドキュメントを個別の公開フローではなく、ビルドプロセスの一部として扱います。

• AI アシスタント — ドキュメントに基づいた RAG 駆動のチャット
• MCP サーバー — 対応するコーディングエージェントによるドキュメントの検索、閲覧、検証
• llms.txt / llms-full.txt — LLM が読み取り可能な完全なドキュメントコンテキスト
• Open Knowledge Format (OKF) — AI および RAG システム向けの構造化ナレッジバンドル
• Agent Skills — LLM およびコーディングエージェント向けの再利用可能な指示セット
• Markdown としてコピー / コンテキストをコピー — ブラウザから直接クリーンなコンテキストを抽出
• セマンティック検索 — 組み込みのキーワード検索に加え、オプションでベクトル検索に対応

拡張性とスケーラビリティ

• ロケール対応検索と生成出力を備えた多言語対応 (i18n)
• 複数のドキュメントリリースに対応したバージョン管理
• モノレポおよびマルチプロジェクト用の Workspaces
• API ドキュメント用 OpenAPI 3.x レンダリング
• 組み込みテンプレート、カスタム CSS/JavaScript、ライト/ダークモード

AI アシスタント & Cloud Relay

docmd には、ドキュメントに基づいた RAG 駆動の AI アシスタントが含まれています。

独自のバックエンドやローカル AI プロバイダーに接続できます。ドキュメントを静的サイトとしてデプロイしている場合は、docmd Cloud Relay がホスト型ブリッジとして機能します。

あなたのドキュメント
        │
        ▼
 @docmd/plugin-ai
        │
        ▼
 docmd Cloud Relay
        │
        ▼
 あなたの AI プロバイダー

Cloud Relay は選択したプロバイダーに安全に AI リクエストを送信するため、API クレデンシャルをブラウザに公開する必要がなく、AI バックエンドを運用する必要もありません。

Cloud Relay はご自身の AI プロバイダーの API キーを使用して無料で利用できます。

• 任意のプロバイダーとモデルを持ち込み可能
• プロバイダーの認証情報をクライアントから保護
• 静的ホスティングでそのまま動作
• デプロイや保守が必要な AI バックエンドが不要
• 利用状況の可視化と読者の質問傾向の把握
• 1 つのアカウントから複数のドキュメントプロジェクトを接続

Cloud Relay をセットアップ → • AI アシスタント ドキュメント →

Cloud Relay の利用は無料です。モデルの使用料は選択した AI プロバイダーによって別途請求される場合があります。

CLI

docmd dev            # ローカル開発サーバーを起動
docmd build          # 本番用にビルド
docmd live           # ブラウザベースの Live エディタを起動
docmd init           # 設定ファイルを作成
docmd doctor         # 設定とプラグインの状態をチェック
docmd validate       # ドキュメントの内部リンクを検証
docmd migrate        # Docusaurus、VitePress、MkDocs、Starlight から移行
docmd deploy         # デプロイ設定を生成
docmd mcp            # stdio 経由で MCP サーバーを実行
docmd add <name>     # プラグインまたはテンプレートをインストール
docmd stop           # 実行中の docmd 開発サーバーを停止

完全な CLI コマンド一覧を見る →

プラグイン

docmd はプラグインシステムを中心に構築されています。一般的なドキュメント機能はコアに含まれており、必要に応じてオプションのプラグインをインストールできます。

オプションプラグインのインストール:

docmd add <plugin-name>

独自プラグインの作成: プラグイン開発ガイド →

設定

設定は任意です。

より詳細な制御が必要な場合は、プロジェクトのルートに docmd.config.json、docmd.config.ts、または docmd.config.js を追加してください:

{
  "title": "マイプロジェクト",
  "url": "https://docs.myproject.com",
  "src": "./docs",
  "out": "./dist"
}

動的な値が必要な場合は、TypeScript および JavaScript の設定ファイルを使用できます。

設定リファレンス →

プログラマティック API

Node.js スクリプト、CI パイプライン、またはカスタムビルドシステムから docmd を利用できます。

import { build } from '@docmd/core';

// プログラムからドキュメントをビルド
await build('./docmd.config.json', { isDev: false });

CommonJS と ESM の両方をサポートしています。

Node API リファレンス →

移行

既存のドキュメントをゼロから作り直す必要はありません。

docmd migrate

Docusaurus、VitePress、MkDocs、Starlight などのサポート対象ドキュメントフレームワーク用の移行ツールが用意されています。

移行ドキュメント →

オープンソース

ドキュメントはプロジェクトの知的資産の中核です。Git リポジトリ内のシンプルな Markdown ファイルとして管理されるべきであり、ポータブルでバージョン管理可能、かつ監査可能であるべきです。

docmd コンパイラおよび公式コアプラグインは MIT ライセンスの下で提供されており、有料化されたコンパイラ機能なしで、永続的に無料で利用できます。

生成されたドキュメントはどこにでもホストでき、docmd がホストするインフラを必要としません。

コミュニティ

• 公式ドキュメント → docs.docmd.io
• 質問・アイデア → GitHub Discussions
• バグ報告・機能リクエスト → GitHub Issues
• 貢献方法 → CONTRIBUTING.md
• ロードマップ → GitHub Discussions

docmd を応援する

docmd が役に立ったら:

• リポジトリに ⭐ を付ける
• ドキュメントを作成している人に共有する
• Issue の起票、バグ修正の貢献、またはプラグインの開発
• GitHub スポンサーで開発を支援

ライセンス

MIT ライセンス。詳細は LICENSE を参照してください。