Docsbook
概要

ドキュメントの管理

サイトの作成後、ドキュメントの扱い方。

Float Widget — Managing Your Site#

ログインして自分のサイトを表示しているとき、右下隅に管理ウィジェットが表示されます。

┌──────────────────────┐
│ 👤 Your Name         │
│                      │
│ ✨ Premium / Free    │
│                      │
│ ⚙️ Settings          │
│ 🚪 Sign Out          │
└──────────────────────┘

アバターまたは設定をクリック

#

管理オプションのメニューが開きます。

構成可能な内容#

1. 基本設定#

  • ワークスペース名 — プロフィールに表示されます
  • サブスクリプションの状態 — 無料またはプレミアム
  • サイト言語 — デフォルト言語

2. ドメイン#

(Premium のみ)

  • カスタムドメインをお持ちの場合は、こちらに指定してください
  • docsbook.io/user/repo の代わりに docs.example.com が表示されます

詳細については: カスタムドメインの設定

3. 外観#

表示オプション:

  • 「Powered by Docsbook」を非表示にする (プレミアム)

    • ページ下部のバッジを削除します
    • サイトを完全にあなただけのものにします

  • テーマ (近日公開)

    • ライト / ダークテーマ
    • 将来的に追加予定です

4. 言語と翻訳#

(Premium only)

  • 自動翻訳を有効にする
  • 言語を選択する
  • ドキュメントが自動的に翻訳されます

詳細については: Document Translation

5. 危険な操作#

⚠️ ワークスペースの削除

「ワークスペースの削除」をクリックすると、以下の操作が行われます。

  • すべての設定を削除します
  • ドキュメントサイトを無効にします
  • これは元に戻せません！

GitHub リポジトリは削除されず、ドキュメントサイトのみが削除されます。

ドキュメントの更新方法？#

方法1：GitHubウェブインターフェース#

  1. github.comであなたのリポジトリを開く
  2. マークダウンファイルを編集する
  3. 「変更のコミット」をクリックする
  4. Docsbookサイトに更新が表示されます

Method 2: Git Locally#

# 1. Clone the repository
git clone https://github.com/username/repo.git
cd repo
 
# 2. Edit files
nano docs/getting-started.md
 
# 3. Stage changes
git add docs/
 
# 4. Make a commit
git commit -m "Update documentation"
 
# 5. Push to GitHub
git push origin main

更新はサイトに自動的に反映されます！

新しいページの追加 (Method 3: Add a New Page)#

  1. リポジトリに新しい .md ファイルを作成します
  2. コンテンツを記述します
  3. コミットします
  4. ファイルがサイトメニューに表示されます

例:

# Create new file
echo "# API Reference" > docs/api/reference.md
 
# Add content
echo "Your API documentation..." >> docs/api/reference.md
 
# Commit
git add docs/api/reference.md
git commit -m "Add API reference"
git push origin main

Method 4: Delete a Page#

  1. GitHubリポジトリからファイルを削除します
  2. 削除をコミットします
  3. ページがサイトから消えます

同期確認#

サイトが更新されないのはなぜですか？#

更新は即時ではありません。以下の点を確認してください:

  1. GitHub でのコミットを確認する

    • github.com → あなたのリポジトリを開く
    • 新しいコミットが見えますか？
    • もしそうでない場合は、ローカルで更新してください

  2. ページを更新する

    • Ctrl+F5 (Mac の場合は Cmd+Shift+R) を押します
    • これにより、ブラウザのキャッシュがクリアされます

  3. 1～2 分待つ

    • 同期は即時ではありません
    • Docsbook は GitHub を定期的に確認します

  4. インターネットを確認する

    • インターネットに接続されていることを確認してください
    • リポジトリが開いているか確認してください

同期に関する問題？#

ファイルがメニューに表示されない:

  • ファイルが .md であることを確認してください
  • ファイル名を確認してください — ラテン文字、数字、ハイフンのみ

いくつかのファイルは更新されたが、他のファイルは更新されなかった:

  • ブラウザのキャッシュが原因である可能性があります
  • Ctrl+F5でキャッシュをクリアしてください

どこでも古いバージョン:

  • 5分待ってください
  • ブラウザのキャッシュをクリアしてください

ドキュメントの構造化#

ファイルを整理するには？#

サイドバーはフォルダー構造から構築されます。論理的に整理してください。

オプション 1: カテゴリ別

docs/
├── README.md
├── getting-started.md
├── api/
│   ├── overview.md
│   ├── auth.md
│   └── endpoints.md
└── guides/
    ├── deployment.md
    └── troubleshooting.md

オプション 2: 詳細レベル別

docs/
├── README.md
├── 1-basics.md
├── 2-intermediate.md
├── 3-advanced.md
└── faq.md

オプション 1 を推奨します — より明確な構造です。

[See API](/ja/docs/guides/getting-started/api/overview)
[Start here](/ja/docs/guides/getting-started/getting-started)
[FAQ](/ja/docs/guides/getting-started/../faq)

これらのリンクは、適切なサイトページリンクに自動的に変換されます。

[Go to installation](#installation)

これらが機能するためには、ファイルの別の場所にこの見出しが必要です:

## Installation
 
Installation instructions...

画像とメディア#

画像を挿入する方法？#

  1. 画像フォルダに追加 (例: docs/images/screenshot.png)
  2. GitHubにアップロード
  3. マークダウンで参照:
![Description](https://raw.githubusercontent.com/docsbook-io/docs/main/guides/getting-started/./images/screenshot.png)

画像をどこに保存しますか？#

フォルダを作成します:

docs/
├── README.md
├── images/
│   ├── screenshot.png
│   ├── architecture.jpg
│   └── diagram.gif
└── guides/

形式#

サポートされている:

  • PNG (最適)
  • JPG (写真用)
  • GIF (アニメーション)
  • WebP (最新形式)

私のドキュメントは誰が閲覧できますか？#

Open Access#

あなたのドキュメントサイトは誰でも閲覧可能です — リポジトリが非公開の場合でも。

誰が見れるか:

  • ✅ インターネット上のすべての人
  • ✅ 検索エンジンのボット (Google, Bing)
  • ✅ GitHubアカウントを持たない人

これは良いことです — あなたのドキュメントはどこでもアクセス可能です！

Only You See Settings#

管理ウィジェットは、ログインしている場合にのみ表示されます。

他の人は次のものだけが見えます:

  • あなたのドキュメントサイト
  • 美しいデザイン
  • コンテンツ
  • 彼らが表示しないもの: コントロールボタン、設定、オプション

共同ドキュメント#

How to work together?#

If multiple people work on documentation:

  1. GitHubリポジトリに参加者を追加 — 彼らは編集できます
  2. 誰でもドキュメントを更新可能 — プルリクエストを送信することで
  3. Docsbookはサイトを自動更新 — メインにマージされるとすぐに

ワークフロー#

Colleague 1         Colleague 2         Docsbook Site
    ↓                   ↓                    ↓
Edits          →   Pull Request    →   Updates
Documentation      (Code Review)       Automatically

ドキュメントのバージョン管理#

⚠️ まだサポートされていませんが、計画中です。

現在、最新バージョンのみが保存されています。

異なるバージョンが必要な場合は：

  • Git ブランチを使用する (docs/v1, docs/v2)
  • または、別のリポジトリを作成する

アナリティクス#

私のドキュメントを誰が読んでいるかを知るにはどうすればよいですか？#

(近日中に組み込みます)

現時点では、以下の方法で確認できます。

  1. Google Analyticsを設定する
  2. ドメインのトラフィックを追跡する
  3. どのページが人気があるかを確認する

セットアップのサポートについては、support@docsbook.io までお問い合わせください。

次のステップ#

提供： Docsbook