Markdown共有ガイド / READMEをGitHub外へ共有

READMEをGitHub外の相手へ共有する方法

READMEをGitHubの画面で共有すると、privateリポジトリの権限やGitHubアカウントが必要になることがあります。markdown共有ツールなら、レビュー対象のREADMEを独立したブラウザページにして、URLを知っている相手へ渡せます。

1. 共有URLが向いている場合

共有ページはリポジトリと同期しません。レビュー時点のスナップショットとして使い、最新版の管理はGitで続けてください。

2. 共有用READMEを準備する

1. 対象ブランチのREADMEを開き、見出し・手順・リンクを確認します。
2. 社内URL、privateリポジトリURL、個人情報、アクセストークンを削除します。
3. ローカル画像がある場合はREADMEと画像フォルダを同じ親フォルダへまとめます。
4. セットアップ手順は、初見の相手が上から実行できる順序にします。

ローカル画像を含む場合は画像付きMarkdownをZIPで共有する方法に従い、相対パスを保ったZIPを作成します。

3. レビューURLを作成する

1. アップロード画面へREADMEまたはZIPを追加します。
2. プレビューで目次、表、コード、画像、リンクを確認します。
3. 短期レビューなら3日または7日、終了日未定なら無期限を選びます。
4. 閲覧者を絞る必要がある場合だけパスワードを設定します。
5. 共有URLを作成し、完成URLをコピーします。

4. 相手へ確認点と一緒に渡す

URLだけでなく、対象と期限を添えるとレビューの往復を減らせます。

READMEのレビューをお願いします。

確認URL: https://markdown.bz/d/共有ID
確認期限: 8月10日
確認してほしい点:
- 初回セットアップだけで手順を完了できるか
- コマンド例に不足がないか
- 用語が初見でも分かるか

共有ページにはコメント機能がないため、フィードバック先はGitHub Issue、メール、チャットなど別途指定してください。

5. READMEを更新した場合

公開後の本文は編集できません。レビュー指摘を反映したら新しい共有URLを作り、古いURLではなく新しいURLを明示して再依頼します。URLの取り違えを避けるため、依頼文へ対象コミットや更新日も記載してください。

6. 公開前の確認

• .envの値、APIキー、Cookie、内部ホスト名を含めない
• privateリポジトリの存在自体を伏せる必要がないか確認する
• URLを知っている人は閲覧できる前提で内容を選ぶ
• パスワード保護を機密保管やエンドツーエンド暗号化の代わりにしない
• 長期保存が必要な原本はGitリポジトリ側で管理する

READMEの共有URLを作る

最終確認日: 2026年8月3日 / 確認: markdown共有ツール運営