專案指南

GitHub 社群預覽圖片:尺寸、設定與檢查表

儲存庫社群預覽是分享連結時可能顯示的圖片。用簡短名稱、一項實用價值及容易辨認的範例,讓人一眼了解專案。它是 README 的補充,而不是替代品。

GitHubStart 編輯團隊 · 更新日期

準備正確的檔案

依 GitHub 目前的說明,可使用小於 1 MB 的 PNG、JPG 或 GIF 檔案。建議至少 640 × 320 像素,1280 × 640 像素則有最佳顯示效果。先使用較大的 2:1 畫布,再縮小許多檢查可讀性。

以虛構的 CSV 驗證工具為例,清楚的版面可以呈現專案名稱、「匯入前檢查 CSV 檔案」,以及一個從輸入到錯誤的簡單範例。不要把整段終端機操作塞進縮圖。重要文字應遠離邊緣,以免分享平台裁切圖片。

上傳並檢查分享連結

開啟儲存庫的 Settings,找到 Social preview,選擇 Edit 並上傳圖片。將公開儲存庫網址分享到受眾會看到的平台,並在該處檢查結果;上傳成功不代表每個平台都會立即替換快取中的預覽。

  • 確認圖片屬於你正在分享的儲存庫。
  • 上傳前檢查檔案格式、像素尺寸及檔案大小。
  • 使用易讀的對比度;透明圖片應分別在淺色及深色背景檢查。
  • 若仍顯示舊圖片,請確認儲存庫設定已儲存,並檢查分享平台的快取。

讓預覽與專案保持一致

圖片、README 和版本公告應使用相同的專案名稱及用途。若截圖展示實驗性功能,請加以標示,或改用穩定的操作流程。不要加入虛構的 Star 數量、客戶標誌或效能宣稱。

專案核心使用情境改變時,也應重新檢視圖片。預覽是傳達資訊的素材,不是排名、點擊率或 GitHub Star 的額外保證。

常見問題

這和儲存庫擁有者的頭像一樣嗎?

不一樣。擁有者頭像用來識別帳號;自訂儲存庫社群預覽則是在分享連結時代表特定專案。

預覽可以使用透明背景嗎?

GitHub 支援 PNG 透明度。請檢查不同背景下的對比度;若不確定分享平台的外觀,實色背景是實用的選擇。

為什麼上傳後仍看到舊預覽?

先確認新圖片已儲存在正確的儲存庫。分享平台可能快取預覽,其更新行為與儲存庫設定是分開的。

參考資料