はじめに

a-git2docs の概要、思想、向いているユースケース。

a-git2docs は、ファイルベースで git 管理のドキュメントサイト基盤です。データベースや管理画面は不要で、Markdown ファイルを書いてコミットするだけでサイトが更新されます。

コンセプト

ドキュメントの真実のソース (single source of truth) は git リポジトリに置くべきだ、というのが a-git2docs の出発点です。記事の変更履歴、レビュー、ブランチでの下書き、リリースのタグ付け、どれも git のモデルに素直に乗ります。

  • 管理画面なし — 記事の追加・修正は Pull Request
  • データベースなし — 記事は Markdown + YAML フロントマター
  • ログインなし — 読者も編集者もアカウント不要
  • ゼロデプロイ設定 — PHP が動く環境ならそのまま配置するだけ

こんなプロジェクトに向いています

  • 開発者向けプロダクトドキュメント
  • 社内 Wiki(git が使える前提の開発組織)
  • オープンソースの公式ドキュメント

こんなプロジェクトには向きません

  • 記事の編集者が非エンジニアで、git を日常的に触らない
  • 記事数が数万件を超えるような大規模サイト
  • ユーザー投稿コンテンツ(CMS 的な機能は持ちません)

メモ

a-git2docs は "書く人が開発者寄り" のチームを想定しています。編集チームが広く非技術者を含む場合は、Contentful や microCMS など別の選択肢を検討してください。

次に読むもの

インストール手順は インストール を、5 分で動かしたい場合は クイックスタート をどうぞ。

前のページ

← インストール