GitHub の README を画像に変換してリリース告知用の PNG を作る
公開 GitHub リポジトリから README を読み込み、バージョン番号と変更点を残して PNG に書き出します。コピーできる例と実際の画像を使い、バッジ、相対パス、改行、リリースへのリンクを確認する手順も紹介します。
リリース告知では、README の短い抜粋でプロジェクトの用途と変更点を伝えられます。GitHub README 画像変換ツールにリポジトリの URL を貼り付け、投稿やスライド、チームのチャットに載せる PNG を作ります。
- 公開リポジトリを開き、トップページの URL をコピーします。読み込みを試すには octocat/Hello-World が使えます。
- URL を貼り付けて README を取得を押し、エディターに目的の内容が入ったか確認します。
- プロジェクト名、バージョン番号、主要な変更点を残します。変換ツール内のコピーを編集します。
- 掲載予定の幅でプレビューを確認し、出力設定で PNG を選んでダウンロードします。
読み込めない場合は、ログインしていない状態でリポジトリを開き、README が表示されるか確認してください。特定のブランチや手元のファイルを使う場合は、対象の版を開いて、公開できる範囲を Markdown 変換ツールに貼り付けます。
公開リポジトリの読み込みを確認した後、エディターの内容を次のオリジナル例に差し替えました。貼り付けて同じレイアウトを再現できます。 編集した抜粋を出力する前に、出力設定で著者名と日付を確認してください。
# Trail Notes 1.2
A small command-line tool for organizing field notes.
## What's new
- Group notes by trip.
- Search by date or tag.
- Export a trip summary as Markdown.
**Quick start:** Open a notes folder, then choose a trip.
PNG 全体を開く。README ツールのライブプレビューから、サイトの出力サービスで生成した画像です。幅は 800 px、出力倍率は 2 倍です。
プレビューでバッジやスクリーンショットが読み込まれているか確認します。docs/demo.png のような相対パスは、リポジトリとファイルの場所に依存します。表示されない場合は、告知する版に対応した公開画像の URL に差し替えます。短い説明と箇条書きだけでもカードを作れます。
ダウンロードした PNG を掲載時の大きさで開きます。長いコマンドや幅の広い表で読みにくくなる場合は、詳細を GitHub に残して、読者がコピーできるようにします。
画像のそばにリポジトリまたはリリースへのリンクを置きます。特定の版を告知するなら、そのリリースページか、該当コミットに固定した README のリンクが便利です。画像が読み込まれなくても伝わるように、短い説明も添えます。準備ができたら、公開 README を画像に変換してみてください。