md2docs

ファイルベースで Git 管理できるドキュメントサイト基盤。Markdown と YAML フロントマターで書いて、コミットすればそのまま公開できます。

md2docs は、ドキュメントの真実のソース (single source of truth) を Git リポジトリに置きたいチームのために作りました。データベース不要、管理画面不要、ログイン不要。PHP が動く環境ならどこにでも置けます。

主な機能

• 記事は Markdown + YAML フロントマター — タイトル省略時は本文の # 見出し を自動でタイトルに
• htmx-boost で SPA-lite なナビゲーション — 左ナビの状態を保ったまま記事を読み進められる
• 「もっと見る」で段階展開 — 一覧もナビも累積ページネーションでスクロール感のある UX
• SQLite FTS5 ベースの全文検索 — オプションで有効化、不要なら DB ゼロで運用可
• アクセントカラーを site.yaml 1 行で切替 — 26 色の Tailwind パレットから選択
• シェアボタンと Markdown コピー — 各記事のタイトル右から URL や本文 md をワンタップで取得
• お気に入り機能 — localStorage に閉じた軽量なブックマーク

始める

• 動作要件と入れ方は インストール
• 5 分で動かすなら クイックスタート
• 記事を書く時のルールは 記事の書き方

下のセクションカードから各章へ進めます。