docmd-io/docmd

Documentation compiler for humans and machines. One Markdown source, one command — website, search, AI context, and knowledge formats together.

何を解決するか

docmd は、Markdown ファイルをプロダクション対応の静的サイトに変換するドキュメント生成ツールです。複雑な設定やボイラープレート、重い JavaScript ペイロードの必要性を排除し、人間の読者と AI エージェントの両方にとって高速で SEO 最適化された体験を提供します。

動作方法

静的サイトジェネレータ(SSG)として動作し、Markdown フォルダのファイル構造から自動的にナビゲーションを生成します。npx を通じてインストールせずに実行可能であり、グローバル CLI ツールとしても利用できます。プラグインアーキテクチャを備えており、検索機能、SEO、AI 機能などの拡張が可能です。

対象ユーザー

設定やビルドパイプラインに時間をかけずにドキュメントを迅速に公開したい開発者、および AI ベースの検索やエージェント対応ドキュメントを統合したい開発者に最適です。

主な特徴

  • ゼロ設定: ナビゲーションとサイト構造はフォルダ構造から自動的に導出されます。
  • AI ネイティブ: 組み込みの RAG ベース AI アシスタント、AI エージェント用の MCP サーバー、llms.txt コンテキストファイルの自動生成を備えています。
  • 高パフォーマンス: 非常に小さな JavaScript ペイロード(約 18 KB)と即時 SPA ナビゲーションを実現します。
  • エンタープライズ対応: バージョン管理、国際化(i18n)、マルチプロジェクトワークスペースをネイティブでサポートしています。
  • 拡張性: Mermaid ダイアグラム、OpenAPI レンダリング、KaTeX 数式などの機能を追加するための強力なプラグインシステムを備えています。

関連

  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト
  • プロジェクト