Repolode
docmd-io

docmd-io/docmd

Markdownのソースフォルダから静的ドキュメントサイトを生成し、オフライン検索、llms.txt、AIエージェント向けコンテキストも出力するコンパイラ。

代替できる製品:DocusaurusMintlify

スター
2,528
フォーク
144
未解決の Issue
2
最終コミット
3 日前

これは何?

docmdはNode.jsベースのドキュメントコンパイラです。Markdownファイルのフォルダを指定すると、ファイル構成からナビゲーションを生成した静的サイトを作成できるため、設定ファイルやfrontmatterを用意しなくてもすぐに始められます。1回のビルドで、オフライン検索インデックス、サイトマップ、SEOおよびOpen Graphのメタデータ、robots.txtも生成します。

同じソースから、機械処理向けの出力も生成できます。docmdはllms.txtとllms-full.txt、RAGシステム向けのOpen Knowledge Formatバンドル、さらにコーディングエージェントがドキュメントを検索、閲覧、検証できるMCPサーバーを生成します。オプションのAI Assistantプラグインを使えば、独自のプロバイダーまたはホスト型のCloud Relayを通じて、ドキュメントを対象にしたRAGベースのチャットを利用できます。

国際化、バージョン管理、モノレポのワークスペース、OpenAPI 3.xのレンダリング、Mermaid図、プラグインシステムに対応しています。Docusaurus、VitePress、MkDocs、Starlightから移行するためのコマンドも用意されています。生成したサイトは任意の静的ホストにデプロイでき、コンパイラとコアプラグインはMITライセンスで提供されています。

主な機能

  • 01ファイル構成に基づくナビゲーション付き静的ドキュメントサイトを生成
  • 02オフライン全文検索、サイトマップ、canonical URL、Open Graphメタデータに対応
  • 03llms.txt、llms-full.txt、Open Knowledge Formatバンドルを出力
  • 04コーディングエージェントがドキュメントを検索、閲覧、検証できるMCPサーバー
  • 05国際化、バージョン管理、モノレポのワークスペースに対応
  • 06OpenAPI 3.xのレンダリングとMermaid図に対応

ユースケース

  • 既存のMarkdownフォルダから、セットアップ不要でプロジェクトのドキュメントを公開する
  • LLMやコーディングエージェントに、ドキュメントから構造化されたコンテキストを提供する
  • 既存のDocusaurus、VitePress、MkDocsサイトを移行する
  • 多言語のAPIドキュメントを任意の静的ホストで公開する

クイックスタート

  1. 1

    docmd に Markdown フォルダーを指定して、開発サーバーを起動する

    npx @docmd/core dev
  2. 2

    デプロイ用の静的サイトをビルドする

    npx @docmd/core build

使う前に知っておきたいこと

  • Node.js 20 以降が必要です。
  • AI Assistant などのオプション機能を利用するには、ご自身の AI プロバイダーのキーまたは Cloud Relay が必要です。また、モデルの利用には別途料金が発生する場合があります。

トピック

よくある質問

docmd とは?
Markdownのソースフォルダから静的ドキュメントサイトを生成し、オフライン検索、llms.txt、AIエージェント向けコンテキストも出力するコンパイラ。 docmdはNode.jsベースのドキュメントコンパイラです。Markdownファイルのフォルダを指定すると、ファイル構成からナビゲーションを生成した静的サイトを作成できるため、設定ファイルやfrontmatterを用意しなくてもすぐに始められます。1回のビルドで、オフライン検索インデックス、サイトマップ、SEOおよびOpen Graphのメタデータ、robots.txtも生成します。
docmd は無料で使えますか?ライセンスは?
docmd は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
docmd は今もメンテナンスされていますか?
活発にメンテナンス中。docmd の最終コミットは 2026年10月16日 です。
docmd は何に使えますか?
既存のMarkdownフォルダから、セットアップ不要でプロジェクトのドキュメントを公開する LLMやコーディングエージェントに、ドキュメントから構造化されたコンテキストを提供する 既存のDocusaurus、VitePress、MkDocsサイトを移行する 多言語のAPIドキュメントを任意の静的ホストで公開する
docmd のインストール方法は?
docmd に Markdown フォルダーを指定して、開発サーバーを起動する: npx @docmd/core dev デプロイ用の静的サイトをビルドする: npx @docmd/core build
docmd はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/docmd-io/docmd

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト