Docsbook
概要

GitHub Integration

読者がGitHubで任意のページを直接編集できるようにし、コミュニティからの貢献を容易にします。

設定#

設定 機能
"GitHubで編集"を表示 すべてのページの最下部に編集リンクを追加します
GitHub編集ベースURL 編集リンクのベースパス

How to Enable#

  1. docsサイトを開きます。
  2. Float Widget → Design → Content タブ。
  3. "Edit on GitHub"を表示をオンにします。
  4. GitHub edit base URLを設定します（下記参照）。
  5. 保存します。

EditベースURLの設定#

EditベースURLは、Docsbookが「GitHubで編集」をクリックしたときに読者をどこに送るかを伝えます。

形式:

https://github.com/{username}/{repo}/edit/{branch}/{docs-folder}

例:

リポジトリ Docsの場所 Editベース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は、このベースURLに現在のページパスを自動的に追加します。

このフィールドを空のままにしておくと、Docsbookはリポジトリに基づいて適切なデフォルトを使用します。

なぜ有効にするのか？#

オープンソースプロジェクトの場合、「GitHubで編集」リンクは不可欠です。コミュニティメンバーが、単一のクリックでタイプミスを修正したり、説明を明確にしたり、例を改善したりできるようにします。

チームドキュメントの場合、チームメンバーはDocsbookの仕組みを知らなくても、ファイルを直接GitHubで編集することで改善を提案できます。

読者を貢献者に変えましょう。 GitHubリポジトリを接続 →

提供： Docsbook