Docsbook
概要

コアコンセプト

ワークスペースとは？

ワークスペース — 単一のGitHubリポジトリにリンクされたドキュメント。

ワークスペースには、次のものが含まれます。

  • マークダウンファイルのrepository
  • ドキュメントサイト（アドレスと外観）
  • 設定（ドメイン、翻訳、スタイル）

仕組みは？

1. You create a Workspace from your GitHub repo
                    ↓
2. Docsbook reads markdown files from GitHub
                    ↓
3. Transforms them into a beautiful site
                    ↓
4. Site is available at: docsbook.io/{user}/{repo}
                    ↓
5. You update files in GitHub
                    ↓
6. Site updates automatically

サイト構造

左パネル — ナビゲーション (サイドバー)

サイドバーは、リポジトリのファイル構造から構築されます:

docs/
├── README.md          → "Home"
├── getting-started.md → "Getting Started"
├── api/
│   ├── auth.md        → "API / Auth"
│   └── endpoints.md   → "API / Endpoints"
└── faq.md             → "FAQ"

次のように表示されます:

📘 Home
📄 Getting Started
📁 API
  └─ Auth
  └─ Endpoints
📄 FAQ

メインコンテンツ

中央領域は、選択されたMarkdownファイルのコンテンツを表示します。

機能：

  • 美しいフォーマット
  • 構文強調表示
  • 表とリスト
  • 他のページへのリンク

右パネル — 概要

右側は、現在のページのヘッダーから自動的に目次を構築します。

Outline:
  - Installation
    - Requirements
    - Steps
  - Usage
  - Troubleshooting

ヘッダーをクリック → ページをスクロールします。

Float Widget — Control Widget

ログイン済みで、ご自身のドキュメントを閲覧している場合、右下隅にウィジェットが表示されます。

誰がウィジェットを見ることができますか？

  • ✅ あなた — あなたのウィジェットを見ることができます
  • ❌ 他の人 — 見ることができません (あなたのアカウントでのみ)

何が表示されますか？

┌─────────────────────────┐
│ 👤 alice               │
│ ✨ Premium             │
│ ⚙️ Settings            │
│ 🚪 Sign out            │
└─────────────────────────┘

ウィジェットでできること

  1. アバターを見る — メニューのためにクリック
  2. ステータスを見る — 無料またはプレミアム
  3. 設定を開く — ドメインを変更したり、翻訳を有効にしたりする
  4. サインアウト — ログアウト

パブリックアクセス

あなたのドキュメントは誰でも閲覧可能です。リポジトリがプライベートであっても、ドキュメントはすべての人に表示されます。

利点：

  • SEO最適化（Googleでインデックス化）
  • プレーンなGitHubよりも美しい外観
  • 高速な読み込み
  • モバイルフレンドリー
  • 全文検索（近日公開）

GitHub 同期

同期はどのように機能しますか？

Docsbook は Webhook は使用しません。代わりに:

  1. GitHub でファイルを更新します
  2. ドキュメントサイトにアクセスします
  3. Docsbook は GitHub で新しいコンテンツをチェックします
  4. 変更がある場合 — 新しいバージョンを表示します

結果: ドキュメントは、閲覧するたびに最新の状態になります。

同期とは？

  • ✅ 新しい .md ファイル
  • ✅ テキストの更新
  • ✅ ファイルの削除
  • ✅ ファイル名の変更
  • ✅ 新しいフォルダ

同期されないものとは？

  • ❌ コードのコメント
  • ❌ コミット履歴
  • ❌ ブランチ情報
  • ❌ その他の形式 (.txt, .rst, など)

無料 vs プレミアム

無料プラン

  • ✅ 1つのパブリックリポジトリ
  • ✅ GitHubとの同期
  • ✅ SEO最適化
  • ✅ 美しいデザイン
  • ✅ モバイル対応
  • ❌ カスタムドメイン
  • ❌ "Powered by Docsbook" の削除
  • ❌ 他言語への翻訳

Premium ($29 one-time lifetime)

Freeの機能に加えて、以下の機能が利用できます。

  • ✅ 無制限のリポジトリ
  • ✅ カスタムドメイン (docs.example.com)
  • ✅ "Powered by Docsbook" バッジの削除
  • ✅ 任意の言語への翻訳
  • ✅ 優先サポート

How to Get Started?

準備はいいですか？ 最初のワークスペースを作成 するのに3分かかります。

質問がありますか？ FAQ を参照してください。

提供： Docsbook