Skip to content

README.ja.md

Latest commit

 

History

History
303 lines (228 loc) · 15 KB

README.ja.md

File metadata and controls

303 lines (228 loc) · 15 KB
Raw
EN  |  DE  |  中文  |  ES  |  日本語  |  FR  |  RU
docmd

Markdown から数秒で本番運用可能なドキュメントを生成。
設定不要。AI ネイティブ。開発者のために設計。

npm version 月間ダウンロード数 GitHub stars ライセンス

公式ウェブサイト  ·  ドキュメント  ·  AI Cloud Relay  ·  ライブエディタ  ·  Agent Skills  ·  バグを報告


docmd デフォルトテーマ — ライト＆ダークモード プレビュー



✦ 0.9 シリーズ — AI、自動化、セキュリティ

0.9.x シリーズは、docmd が AI 対応のドキュメントジェネレーターから、人間と AI エージェントの両方のために設計されたドキュメントプラットフォームへと拡張する重要なリリースです。

このシリーズでは AI アシスタント が導入され、独自の API キー、ローカル AI、または独自のバックエンドを持たない静的サイト向けの docmd Cloud Relay を使用して、対話形式でドキュメントを検索できるようになります。また、MCP、生成された LLM コンテキスト、Agent Skills、構造化ナレッジフォーマットにより、docmd の AI エコシステムが拡張されます。

AI に加え、コアなドキュメント体験、検索、デプロイ、開発者ワークフローの改善を継続しながら、セキュリティ、プライバシー、自動化 に焦点を当てています。

0.9 ロードマップを追う →

クイックスタート

Markdown ファイルが含まれる任意のフォルダで docmd を実行できます（インストール不要）:

npx @docmd/core dev
http://localhost:3000 で開きます
    _                 _ 
  _| |___ ___ _____ _| |
 | . | . |  _|     | . |
 |___|___|___|_|_|_|___|

 v0.9.0

BUILD
  Engine          JS
  Source          docs/
  Output          site/
  Versions        2 (06, 05)
  Locales         7 (en, hi, zh, es, de, ja, fr)

DATA INDEXING
  [ DONE ] Syncing git metadata
  [ DONE ] Building search index & RAG embeddings (multi-version)
  [ DONE ] Generating AI Assistant RAG context

PUBLISHING
  [ DONE ] Generated robots.txt
  [ DONE ] Generated .nojekyll (disables Jekyll on GitHub Pages)
  [ DONE ] Generated sitemap
  [ DONE ] Generating LLMs context files (llms.txt)
  [ DONE ] Generating OKF bundles

⬢ Initial build completed in 1.2s.

WATCHING
  Source          ./docs
  Config          ./docmd.config.json
  Assets          ./assets

DEVELOPMENT SERVER RUNNING
  Local Access    http://127.0.0.1:3000
  Network Access  http://192.168.1.6:3000
  Serving from    ./site

ナビゲーションはファイル構造から自動生成されます。設定ファイル、Frontmatter、特別なフレームワークの学習は一切不要です。

本番デプロイの準備が整ったら:

npx @docmd/core build

Vercel、Cloudflare Pages、Netlify、GitHub Pages、またはその他の静的ホスティングに即座にデプロイ可能な高最適化静的サイト（SPA）が出力されます。

動作要件: Node.js 18+

またはグローバルインストール / Docker 経由で実行
# npm でグローバルインストール
npm install -g @docmd/core

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

# 実行
docmd dev    # 開発サーバー起動
docmd build  # 本番ビルド

または Docker 経由で実行:

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

再現可能なビルドのためにバージョンを固定することを推奨します。

なぜ docmd なのか？

image

Docusaurus、Mintlify などとの完全な比較を見る →

主な特徴

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

Markdown フォルダを指定するだけで docmd が起動します。ファイル階層構造からナビゲーションが自動構築されるため、設定ファイルや事前設計なしで 1 分以内に最初のドキュメントを公開可能です。

超軽量、どこでも高速

デフォルトの JavaScript ペイロードは僅か約 18 kb。高速な SPA 画面遷移を実現します。出力は SEO に最適化された静的 HTML で、サイトマップ、カノニカル URL、Open Graph メタデータが含まれます。クラウド不要のオフライン全文検索も内蔵しています。

AI ネイティブ設計

docmd は、ドキュメント自体を置き換えることなく、現代におけるドキュメントの読み取り・活用方法として AI を第一級の要素として扱います。

  • AI アシスタント (@docmd/plugin-ai) — あなたのドキュメントに基づく RAG 駆動のチャット。独自の API キーまたはローカル AI プロバイダーを使用でき、AIPlug 経由で 100 以上のプロバイダーをサポート。
  • Cloud Relay — 独自バックエンドを運用することなく、静的ドキュメント上で AI アシスタントを有効化。試してみる →
  • MCP サーバー — docmd mcp により stdio 経由で AI エージェントにドキュメントを公開し、直接検索・閲覧・検証を可能にします。
  • コンテキスト生成 (llms.txt / llms-full.txt) — ビルド時に生成される完全なドキュメントコンテキスト。
  • Agent Skills — LLM および IDE エージェント向けのモジュール式指示セット。
  • Open Knowledge Format (OKF) — AI システム向けの構造化された多言語知識パッケージ。
  • Markdown / コンテキストとしてコピー — ブラウザからワンクリックで抽出でき、AI チャットへの貼り付けに最適化。

拡張性と拡張機能

  • 多言語マルチロケールビルド対応（言語ごとの検索インデックス、llms、okf、hreflang）
  • 複数リリースのバージョン管理（現在の最新バージョンを自動認識）
  • モノレポや複数プロジェクト構築のための Workspaces 機能
  • コア機能を拡張する強固なプラグインシステム（Hook 毎の型検証、非同期処理対応）
  • テーマカスタマイズ、組み込みテンプレート、カスタム CSS/JS、ライト/ダークモード対応

CLI

docmd dev            # ローカル開発サーバー起動
docmd build          # 本番用静的サイトビルド
docmd live           # ブラウザベースの Live エディタ起動
docmd init           # カレントフォルダに docmd.config.json を初期化
docmd stop           # 実行中の `docmd dev` / `docmd live` サーバーを停止
docmd doctor         # 設定とプラグインの診断チェック
docmd migrate        # Docusaurus, VitePress, MkDocs, Starlight からの移行
docmd deploy         # Docker, NGINX, Caddy, Vercel, Netlify 用設定の自動生成
docmd validate       # 内部リンクとアンカーの死線チェック
docmd mcp            # stdio 経由で MCP サーバーとして実行
docmd add <name>     # プラグインまたはテンプレートの追加

プラグイン

コア機能は強固なプラグインシステムによって駆動されます。基本機能はデフォルトで含まれており、必要に応じてオプションのプラグインを追加できます。

プラグイン ステータス 説明
ai コア BYOK、ローカルプロバイダー、Cloud Relay 対応の RAG 駆動 AI アシスタント
search コア オフライン全文検索（キーワード検索 ＋ docmd-search 経由のセマンティック検索）
seo コア SEO タグおよび Open Graph メタデータ生成
sitemap コア sitemap.xml の自動生成
git コア Git コミット履歴と最終更新日時の取得
analytics コア 軽量アクセス解析インテグレーション
llms コア AI コンテキストファイル生成 (llms.txt / llms-full.txt)
okf コア AI エージェント向け Open Knowledge Format パッケージ（ロケール別）
mermaid コア Mermaid ダイアグラム表示対応
openapi コア ビルド時の OpenAPI 3.x 仕様レンダラー
pwa オプション Progressive Web App — オフライン閲覧
threads オプション インラインディスカッションスレッド (by @svallory)
math オプション KaTeX / LaTeX 数式レンダリング

オプションプラグインの追加:

docmd add <plugin-name>

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

設定

開発を開始するにあたり設定ファイルは一切不要です。より詳細な制御が必要な場合のみ、ルートディレクトリに docmd.config.json (または .ts / .js) を作成してください:

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

動的な値を扱うための TypeScript および JavaScript 設定ファイルもサポートされています。

詳細な設定オプション: 設定リファレンス

プロジェクト構造例

my-docs/
├── docs/                ← Markdown ドキュメント
├── assets/              ← 画像や静的ファイル
├── docmd.config.json    ← 任意の設定ファイル
└── package.json

ライブエディタ (Live Editor)

ローカル環境の構築不要で、ブラウザ上で直接ドキュメントの執筆とプレビューが可能です。

live.docmd.io で試す

Node.js Programmatic API

Node.js スクリプト、CI パイプライン、カスタムビルドステップから docmd を利用可能です。（CommonJS および ESM 両対応）

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

await build('./docmd.config.json', { isDev: false });

詳細リファレンス: Node API リファレンス

コミュニティ

支援・サポート

  • docmd の開発を最も直接的に支援する方法は、周囲の開発者に共有することです。X で共有する か、スターを付けてください。
  • docmd が開発時間の節約に役立った場合は、GitHub スポンサー をご検討ください。
  • アイデアやバグ報告、独自プラグインの PR も大歓迎です！

ライセンス

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