Hosting obrazów dla GitHub README

Obrazy w README ładują się najlepiej z stabilnych URL-i HTTPS. Prześlij swój zasób, skopiuj bezpośredni link i odwołaj się do niego w Markdown, aby współpracownicy mogli zobaczyć diagramy i zrzuty ekranu w widoku repozytorium.

GitHub renderuje obrazy README z absolutnych URL-i. Prześlij PNG lub WebP dla zrzutów UI; SVG może pozostać w repozytorium, gdy polityka na to pozwala, w przeciwnym razie zrastruj za pomocą naszego narzędzia SVG→PNG.

Zachowaj małe pliki: kompresuj przed hostingiem, aby klony i mobilni widzowie pozostali szybcy.

Dla dużych diagramów rozważ podział na wiele obrazów lub linkowanie do dokumentacji.

Użyj znaczących nazw plików przed przesłaniem, aby tekst alternatywny pozostał jasny.

Jeśli link wygasa po upływie terminu, odśwież obraz, ponownie przesyłając go z dłuższym okresem przechowywania dla projektów długoterminowych.

Połącz z naszym przewodnikiem Stack Overflow podczas krzyżowego publikowania problemów z dokumentacją.

Related tools & pages

Upload an image now

FAQ

Zobowiązane zasoby używają surowych URL-i; zewnętrzne hosty działają, gdy nie chcesz, aby binaria były w historii git — wybierz na podstawie polityki repozytorium i rozmiaru.

PNG dla wyraźnego UI, WebP, gdy potrzebujesz mniejszych rozmiarów i widzowie to wspierają, JPEG dla zdjęć.

Tak — deweloperzy mogą zintegrować się za pomocą naszego API REST dla powtarzalnych procesów dokumentacyjnych.

Zależy od wybranego okresu przechowywania podczas przesyłania; wybierz dłuższy okres przechowywania dla wiecznych odznak i banerów README.