Docsbook
概要

README.mdを本格的なドキュメントサイトに変える

あなたのプロジェクトのドキュメントはREADME.mdにあります。本格的なドキュメントサイトを構築するつもりではいたものの、Docusaurusを調べ、設定ガイドを開き、タブを閉じました。

この記事は5秒でできる代替案です。

要約#

  • ほとんどのOSSプロジェクトは、ドキュメントをREADME.mdのみで公開しています
  • READMEでも問題ありませんが、実際のドキュメントサイトほどGoogleで適切にインデックスされず、AIチャット、分析機能、翻訳機能もありません
  • Docsbookは、README.md（およびオプションのdocs/）を5秒でdocsbook.io/yourorg/yourrepo上のサイトに変換します
  • 公開リポジトリの公開には費用がかかりません。CI/CDも設定ファイルも不要です。

READMEだけでは不十分な理由#

READMEだけのプロジェクトにおける3つの損失：

1. SEO#

GitHubのREADMEはインデックスに登録されますが、Googleがgithub.com/user/repoを表示するのはリポジトリ名で検索した場合であり、技術的な検索クエリに対してではありません。ユーザーが「Xライブラリで認証する方法」を検索しても、答えがREADMEに記載されている場合でさえ、READMEにたどり着くことはほとんどありません。

docs.yourproject.com（またはdocsbook.io/yourorg/yourrepo）にある実際のドキュメントサイトは、READMEがカバーしていても検索結果に表示できないロングテールクエリで上位に表示されます。

2. AIによる配信#

ChatGPTやPerplexityはGitHubのREADMEを引用しますが、一貫しているわけではありません。llms.txt、構造化された見出し、JSON-LDを備えた整理されたドキュメントサイトは、はるかに頻繁に引用されます。

プロジェクトが開発者による発見に依存しているなら、AIによる引用は今や現実的なチャネルです — ChatGPTにドキュメントを引用してもらう方法をご覧ください。

3. UX#

1,500行のREADMEは、ひたすらスクロールする1つの壁です。ドキュメントサイトなら、サイドバー、検索、アンカーリンクとしての見出し、パンくずリスト、コードをコピーするボタンが使えます。同じコンテンツでも、見つけやすさが大幅に向上します。

5秒でセットアップ#

3つの手順:

  1. docsbook.ioにアクセス
  2. GitHubでサインイン
  3. github.com/yourorg/yourrepoを貼り付け

サイトはdocsbook.io/yourorg/yourrepoで公開されます。READMEがホームページとして表示されます。docs/フォルダーがある場合、そのページがサイドバーになります。

設定不要。docsbook.config.js不要。CI/CDパイプライン不要。デプロイ不要。

インデックスされるもの#

Docsbook は以下を読み取ります：

  • README.md（リポジトリのルート）→ ホームページ
  • docs/ フォルダー（再帰的に）→ サイトページ
  • docs/README.md → ドキュメントのランディングページ
  • YAML フロントマター（title、description）→ ページのメタデータ

README しかない場合は、1 ページのドキュメントサイトになります。docs/getting-started.md、docs/api.md などがある場合は、フォルダー構造から作成されたサイドバーを備えた複数ページのサイトになります。

フロントマター（任意）#

任意の Markdown ファイルの先頭に YAML を追加します：

---
title: "Quick Start"
description: "Get up and running in 60 seconds"
---
 
# Quick Start
...

title は検索エンジンでページタイトルになります。description はメタディスクリプションになります。両方を省略した場合、Docsbook は最初の H1 をタイトルとして、最初の段落を説明として使用します。

OSSプロジェクトの公開にはいくらかかりますか？#

サイトの公開には費用がかからず、読む人にも費用はかかりません。従量課金の対象となるのはAIの利用です。各プロジェクトには固有の残高があり、アシスタントへの質問や翻訳の実行で消費されます。現在の料金はdocsbook.io/pricingで確認できます。料金は、リクエストごとに最新の料金定数から生成されます。

リポジトリを公開すると、次のものが利用できます。

  • サイトとして表示される、任意の公開GitHubリポジトリ
  • カスタムサイト名、アイコン、ロゴ、ライトモードとダークモード用のアクセントカラー
  • テーマ切り替え、検索、パンくずリスト、コードコピーボタン
  • ヘッダーリンクとソーシャルリンク（GitHub、Discord、X）
  • アナリティクス — ページビュー、人気ページ、参照元、国
  • llms.txt と llms-full.txt（AIによる発見性向上）
  • Claude CodeやCursorがドキュメントを読み取り、編集できるMCPサーバー
  • README.md と docs/ を基盤とするAIチャット
  • 自動SSL対応のdocs.yourproject.com

オフにできない唯一のものは、ページフッターにある小さな「Powered by Docsbook」リンクです。このリンクはすべてのDocsbookサイトに例外なく表示されます。これは、自分でホスティングを運用しなくてよい代わりの条件です。

docsbook.io の代わりに独自のドメインを使用するには？#

サブドメインを Docsbook に指定すると、SSL が自動的にプロビジョニングされた状態で、そこでドキュメントが提供されます。

  • ダッシュボード → 設定 → ドメイン
  • DNS: CNAME docs → cname.vercel-dns.com
  • SSL は自動です

エイペックスドメインとリダイレクトを含む完全な手順: ドキュメント用のカスタムドメイン。

プッシュすると何が起こるか#

コミットをmainにプッシュします。Docsbookが変更をインデックス化し、サイトを更新します。GitHub Actionもビルド手順も必要ありません。新しいコンテンツは数秒以内に公開されます。

よくある質問#

プライベートリポジトリでも利用できますか？#

はい。DocsbookはGitHub OAuthスコープを通じて認証を行い、公開されたサイト自体をパブリックまたはプライベートに設定できます。

MDX やインタラクティブなデモについては？#

Docsbook は Markdown ファーストです。インタラクティブなデモの場合は、デモを別の場所でホストしてリンクしてください。プロジェクトでドキュメントページ内に React コンポーネントを埋め込む必要がある場合は、2026 年に Docusaurus から移行すべきですか？をご覧ください。その用途には Docusaurus のほうが適しています。

他のDocsbookサイトと同じように見えますか？#

ブランドカラー、フォント、レイアウト、ヘッダー、フッター、サイドバー、独自ドメインを自由に設定できます。削除できないのは、フッターにある小さな「Powered by Docsbook」リンクだけです。このリンクはすべてのDocsbookサイトに表示されます。

後で移転できますか？#

はい。ファイルは GitHub にあります。サブスクリプションをキャンセルして、DNS を別の場所に向ければ、コンテンツはそのままです。

github.com/yourorg/yourrepo を貼り付ければ、5 秒でサイトが公開されます。リポジトリから何もコピーされないため、README が常に信頼できる情報源です。

無料で始める — クレジットカード不要

次のステップ#

Updated

このページは役に立ちましたか？

提供： Docsbook