Docsbook
概要

GitHubで編集リンクを追加する

GitHubで編集リンクはDocsbookサイトのすべてのページの下部に表示され、そのページのソースファイルをGitHubエディターで開きます。誤字に気づいた読者は、Docsbookについて何も知らなくても修正してプルリクエストを作成できます。

別の情報をお探しですか？このページでは、読者向けの編集リンクについて説明します。GitHubアカウントを接続したり、Docsbookでホストされているプロジェクトを自分が所有するリポジトリに移動したりするには、AIチャットヘッダーでプロジェクトピッカーを開き、接続済みリポジトリを使用してください — クイックスタートをご覧ください。

2つの設定の役割#

設定 役割
「GitHub で編集」を表示 すべてのページの下部に編集リンクを追加します
GitHub 編集ベース URL リンクの構築元となるベースパス
  1. サインインした状態でドキュメントサイトを開きます。
  2. Float Widget → デザイン → コンテンツタブを開きます。
  3. 「GitHubで編集」を表示をオンにします。
  4. GitHub編集ベースURLを設定します — 次のセクションを参照してください。
  5. 保存をクリックします。

GitHub 編集ベース URL を設定する#

編集ベース URL は、リンクをクリックした読者の移動先を Docsbook に伝えます。Docsbook は現在のページのパスをこの URL に追加します。

https://github.com/YOUR_USERNAME/YOUR_REPO/edit/YOUR_BRANCH/YOUR_DOCS_FOLDER

Markdown ファイルの場所に一致する行を選択してください。

リポジトリ ドキュメントの場所 編集ベース URL
myname/my-repo リポジトリのルート https://github.com/myname/my-repo/edit/main
myname/my-repo /docs フォルダー https://github.com/myname/my-repo/edit/main/docs
myname/my-repo master ブランチ https://github.com/myname/my-repo/edit/master

フィールドを空のままにすると、Docsbook は接続したリポジトリからリンクを作成します。

有効にするタイミング#

オープンソースプロジェクトでは、編集リンクは提供できる最も手軽な貢献方法です。読者がブラウザー上で誤ったフラグや古いバージョン番号を修正すれば、課題ではなくプルリクエストを受け取れます。

社内チーム向けドキュメントでは、Docsbookのインターフェースを学ばなくても、チームの誰もが文言の変更を提案できます。GitHub上でファイルを編集すれば、サイトにも反映されます。

編集リンクはAIモデルを呼び出さないため、プロジェクトの残高を消費しません。

次のステップ#

読者をコントリビューターに変えましょう

新しいプロジェクトには最初から1ドルの残高があり、編集リンクを使っても残高は消費されません。

プロジェクトを作成

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