Ostatnio dołączyłem do GitHub . Prowadziłem tam kilka projektów.
Muszę dołączyć niektóre obrazy do mojego pliku README. Nie wiem jak to zrobić.
Szukałem tego, ale dostałem tylko kilka linków, które mówią mi: „hostuj obrazy w sieci i określ ścieżkę obrazu w pliku README.md”.
Czy istnieje sposób, aby to zrobić bez hostowania obrazów w jakichkolwiek zewnętrznych serwisach hostingowych?
Odpowiedzi:
Spróbuj tego przeceny:
Myślę, że możesz połączyć bezpośrednio z surową wersją obrazu, jeśli jest on przechowywany w twoim repozytorium. to znaczy
źródło
https://github.com/[username]/[reponame]/blob/[branch]/image.jpg?raw=true
Możesz także użyć ścieżek względnych, takich jak
źródło
![What is this](myimage.png)
oto szczegółowy film z YouTube, który szczegółowo to wyjaśnił:
https://www.youtube.com/watch?v=nvPOUdz5PL4
źródło
To o wiele prostsze.
Po prostu prześlij swój obraz do katalogu głównego repozytorium i połącz go z nazwą pliku bez ścieżki, na przykład:
źródło
docs/images
lub cokolwiek, małe zrzuty ekranu png są w porządku IMHOlogo.png
zdjęć w katalogu głównym repo, aby ustawić awatar do repo. Chciałem dołączyć to zdjęcie do README.md.Możesz także dodawać obrazy za pomocą prostych tagów HTML :
źródło
Wiele opublikowanych rozwiązań jest niekompletnych lub nie w moim guście.
Moim preferowanym rozwiązaniem, zainspirowanym tą istotą , jest użycie gałęzi aktywów z linkami do konkretnych wersji .
Utwórz „bezpośredni link” do tej wersji obrazu i zawiń go w Markdown.
Aby zawsze wyświetlać najnowszy obraz w gałęzi zasobów, użyj adresu URL obiektu blob:
(Z tej samej strony pomocy GitHub Widoki plików pokazują najnowszą wersję w oddziale )
źródło
git reset --hard
; upewnij się, że zmiany zostały zatwierdzone.~/Downloads
,/tmp
, itd.).Zatwierdź swój obraz ( image.png ) w folderze ( myFolder ) i dodaj następujący wiersz w README.md :
![Optional Text](../master/myFolder/image.png)
źródło
Następnie skopiuj źródło obrazu
Teraz dodaj
![alt tag](http://url/to/img.png)
do pliku README.mdGotowy!
Alternatywnie możesz skorzystać z witryny hostingu obrazów, takiej jak
imgur
uzyskać adres URL i dodać go do pliku README.md lub hostować pliki statyczne.Przykładowy problem
źródło
Stworzyłem małego kreatora, który pozwala tworzyć i dostosowywać proste galerie obrazów dla pliku Readme repozytorium GitHub: patrz ReadmeGalleryCreatorForGitHub .
Kreator wykorzystuje fakt, że GitHub zezwala na występowanie znaczników img w
README.md
. Ponadto kreator korzysta z popularnej sztuczki polegającej na przesyłaniu obrazów do GitHub poprzez przeciąganie i upuszczanie ich w obszarze problemu (jak już wspomniano w jednej z odpowiedzi w tym wątku).źródło
Po prostu dodaj
<img>
tag do README.md z relatywnym plikiem src do repozytorium. Jeśli nie używasz względnego src, upewnij się, że serwer obsługuje CORS.Działa, ponieważ obsługuje GitHub inline-html
Obserwuj tutaj
źródło
Podstawowa składnia
Tutaj:
Przykład:
Będzie to wyglądać następująco:
źródło
Użyj stołów, aby się wyróżnić, nada to osobny urok
Składnia tabeli to:
Oddziel każdą komórkę kolumny symbolem
|
i nagłówek tabeli (pierwszy rząd) według drugiego rzędu według
---
| kol 1 | kol. 2 |
| ------------ | ------------- |
| zdjęcie 1 | zdjęcie 2 |
wynik
Teraz po prostu ustaw
<img src="url/relativePath">
obraz 1 i obraz 2, jeśli używasz dwóch obrazówUwaga: jeśli używasz wielu obrazów, po prostu dodaj więcej kolumn, możesz użyć atrybutu width i height, aby wyglądało to czytelnie.
Przykład
| kol 1 | kol. 2 |
| ------------ | ------------- |
|
<img src="https://media.wired.com/photos/5926db217034dc5f91becd6b/master/w_582,c_limit/so-logo-s.jpg" width="250">
|<img src="https://mk0jobadderjftub56m0.kinstacdn.com/wp-content/uploads/stackoverflow.com-300.jpg" width="250">
|Odstępy nie mają znaczenia
Obraz wyjściowy
wspomagany przez: adam-p
źródło
Możesz po prostu zrobić:
Następnie możesz po prostu odwołać się do niego w
README
pliku w następujący sposób:![diagram](diagram.png)
źródło
W moim przypadku używam imgur i w ten sposób używam bezpośredniego łącza.
źródło
Możesz połączyć się z obrazami w swoim projekcie z README.md (lub zewnętrznie), używając alternatywnego łącza github CDN.
Adres URL będzie wyglądał następująco:
Mam obraz SVG w moim projekcie i gdy odwołuję się do niego w dokumentacji projektu Python, nie jest renderowany.
Link do projektu
Oto link do projektu do pliku (nie jest renderowany jako obraz):
https://github.com/jongracecox/anybadge/blob/master/examples/awesomeness.svg
Przykład osadzonego obrazu:
Nieprzetworzony link
Oto link RAW do pliku (nadal nie jest renderowany jako obraz):
https://raw.githubusercontent.com/jongracecox/anybadge/master/examples/awesomeness.svg
Przykład osadzonego obrazu:
Łącze CDN
Za pomocą łącza CDN mogę połączyć się z plikiem za pomocą (renderuje jako obraz):
https://cdn.rawgit.com/jongracecox/anybadge/master/examples/awesomeness.svg
Przykład osadzonego obrazu:
W ten sposób mogę używać obrazów z mojego projektu zarówno w moim
README.md
pliku, jak i w moim projekcie PyPi reStructredText Doucmentation ( tutaj )źródło
Rozwiązałem ten problem. Musisz tylko odwołać się do czyjegoś pliku readme.
Najpierw należy przesłać plik obrazu do biblioteki kodów github! Następnie bezpośrednie odniesienie do adresu pliku obrazu.
źródło
Zwykle hostuję obraz na stronie, może to prowadzić do dowolnego hostowanego obrazu. Po prostu wrzuć to do pliku Readme. Działa dla
.rst
plików, nie jestem pewien.md
źródło
W moim przypadku chciałem wyświetlać ekran drukowania na,
Github
ale także naNPM
. Mimo że użycie ścieżki względnej działało wewnątrzGithub
, nie działało poza nią. Zasadniczo, nawet jeśli przesunąłem również mój projekt doNPM
(który używa tego samegoreadme.md
, obraz nigdy się nie wyświetlał).Próbowałem na kilka sposobów, na koniec to, co mi się udało:
![Preview](https://raw.githubusercontent.com/username/project/master/image-path/image.png)
Teraz widzę mój obraz poprawnie w
NPM
dowolnym miejscu, w którym mógłbym opublikować swój pakiet.źródło
Jeśli potrzebujesz załadować zdjęcia do dokumentacji, dobrym rozwiązaniem jest użycie git-lfs . Zakładając, że zainstalowałeś git-lfs, wykonaj następujące kroki:
Zinicjalizuj git lfs dla każdego typu obrazu:
Utwórz folder, który będzie używany jako lokalizacja obrazu, np.
doc
. W systemach opartych na GNU / Linux i Unix można to zrobić za pomocą:Skopiuj wklej dowolne obrazy do folderu doc. Następnie dodaj je za pomocą
git add
polecenia.Zatwierdź i pchnij.
Obrazy są publicznie dostępne w następującym adresie URL:
https://media.githubusercontent.com/media/ ^ github_username ^ / ^ repo ^ / ^ branch ^ / ^ image_location in the repo ^
Gdzie: *
^github_username^
to nazwa użytkownika w github (można ją znaleźć na stronie profilu) *^repo_name^
to nazwa repozytorium *^branch^
to gałąź repozytorium, do której obraz jest przesyłany *^image_location in the repo^
to lokalizacja zawierająca folder, w którym obraz jest przechowywany.Możesz także najpierw załadować obraz, a następnie odwiedzić lokalizację na stronie github swoich projektów i nawigować, aż znajdziesz obraz, a następnie naciśnij
download
przycisk, a następnie skopiować i wkleić adres URL z paska adresu przeglądarki.Spójrz na to z mojego projektu jako odniesienie.
Następnie możesz użyć adresu URL, aby je uwzględnić, korzystając ze składni Markdown wspomnianej powyżej:
Np .: Załóżmy, że używamy tego zdjęcia. Następnie możesz użyć składni markdown:
źródło
TYLKO TO DZIAŁA !!
zadbaj o to, aby nazwa pliku była zapisana wielkimi literami w tagu i umieść plik instalacyjny w pliku PNG, a następnie umieść łącze do nazwy pliku bez ścieżki:
źródło
Po prostu poszerzam lub dodam przykład do już zaakceptowanej odpowiedzi.
Po umieszczeniu obrazu w repozytorium Github.
Następnie:
![alt text](https://raw.githubusercontent.com/username/projectname/branch/path/to/img.png)
Tak jest w moim przypadku
![In a single picture](https://raw.githubusercontent.com/shadmazumder/Xcode/master/InOnePicture.png)
Gdzie
shadmazumder
jest mójusername
Xcode
jestprojectname
master
jestbranch
InOnePicture.png
jestimage
, W moim przypadkuInOnePicture.png
znajduje się w katalogu głównym.źródło
Można to zrobić na 2 proste sposoby:
1) użyj tagu HTML img,
2)! [] (Ścieżka, w której zapisany jest twój obraz / image-name.png)
ścieżkę, którą możesz skopiować z adresu URL w przeglądarce podczas otwierania tego obrazu. może występować problem z odstępami, więc upewnij się, że jest jakieś spacja czarno-białe dwa słowa ścieżki lub w nazwie obrazu add->% 20. podobnie jak przeglądarka.
Oba będą działać, jeśli chcesz dowiedzieć się więcej, możesz sprawdzić mój github -> https://github.com/adityarawat29
źródło
![](images/ss_apps.png)
Tę odpowiedź można także znaleźć na stronie : https://github.com/YourUserAccount/YourProject/blob/master/DirectoryPath/ReadMe.md
Wyświetlaj obrazy z repozytorium za pomocą:
domena prepend: https://raw.githubusercontent.com/
dołącz flagę:
?sanitize=true&raw=true
użyj
Przykładowy adres URL działa w przypadku plików SVG, PNG i JPG przy użyciu:<img />
taguraw.githubusercontent.com/
YourUserAccount/
YourProject/
YourBranch/
DirectoryPath/
example.png
Działa dla SVG, PNG i JPEG
Przykładowy kod wyświetlany poniżej po użyciu:
raw.githubusercontent.com :
Dzięki: - https://stackoverflow.com/a/48723190/1815624 - https://github.com/potherca-blog/StackOverflow/edit/master/question.13808020.include-an-svg-hosted-on-github -in-markdown / readme.md
źródło
Znalazłem inne rozwiązanie, ale zupełnie inne i wyjaśnię to
Zasadniczo użyłem tagu, aby wyświetlić obraz, ale chciałem przejść do innej strony po kliknięciu obrazu i oto, jak to zrobiłem.
Jeśli umieścisz go obok siebie, oddzielając nową linię, myślę, że po kliknięciu obrazu przechodzi on do tagu, który zawiera odnośnik do innej witryny, którą chcesz przekierować.
źródło
NAJNOWSZY
Teraz możesz użyć:
-LUB-
Wykonaj następujące kroki:
Na GitHub przejdź do strony głównej repozytorium.
Pod nazwą swojego repozytorium kliknij Wiki.
Za pomocą paska bocznego wiki przejdź do strony, którą chcesz zmienić, a następnie kliknij Edytuj.
Na pasku narzędzi wiki kliknij Obraz .
Odwołaj dokumenty .
źródło
Rozważ użycie a,
table
jeśli dodajesz wiele zrzutów ekranu i chcesz wyrównać je przy użyciu danych tabelarycznych w celu poprawy dostępności, jak pokazano tutaj:Jeśli parser Markdown to obsługuje, możesz również dodać
role="presentation"
atrybut WIA-ARIA do elementu TABLE i pominąćth
tagi.źródło
Proces krok po kroku, najpierw utwórz folder (nazwij swój folder) i dodaj obraz / obrazy, które chcesz przesłać w pliku Readme.md. (możesz również dodać obraz / obrazy do dowolnego istniejącego folderu swojego projektu.) Teraz kliknij ikonę edycji pliku Readme.md, a następnie
Po dodaniu obrazu możesz zobaczyć podgląd zmian w zakładce „Podgląd zmian”. Tutaj znajdziesz swój obraz. na przykład w ten sposób, w moim przypadku
folder aplikacji -> folder src -> folder główny -> folder res -> folder do rysowania -> i wewnątrz folderu do rysowania znajduje się plik refrence_image.png. Aby dodać wiele zdjęć, możesz to zrobić w ten sposób,
Uwaga 1 - Upewnij się, że nazwa pliku obrazu nie zawiera spacji. Jeśli zawiera spacje, musisz dodać% 20 dla każdego spacji między nazwą pliku. Lepiej jest usunąć spacje.
Uwaga 2 - możesz nawet zmienić rozmiar obrazu za pomocą tagów HTML lub istnieją inne sposoby. możesz google uzyskać więcej. Jeśli tego potrzebujesz.
Następnie napisz komunikat zmian zmian, a następnie zatwierdź zmiany.
Jest wiele innych sposobów, jak to zrobić, stworzyć problem itp. Itd. Zdecydowanie jest to najlepsza metoda, na jaką się natknąłem.
źródło
Możemy to zrobić po prostu
div
numerupo kilku sekundach zostanie wygenerowany link. Teraz skopiuj link lub adres URL obrazu i użyj go na dowolnej obsługiwanej platformie.
źródło
Dodaj obraz w swoim repozytorium z opcji przesyłania pliku, a następnie do pliku README
źródło
Jest jeszcze jedna opcja, o której nie wspomniałem. Możesz po prostu utworzyć kolejne repozytorium w ramach użytkownika lub organizacji o nazwie „zasoby”. Przekaż swoje zdjęcia do tego repozytorium i odwołaj się do nich z innych repozytoriów:
Zrobiłem to w jednym z moich repozytoriów i to mi odpowiada. Mogę wersjonować moje obrazy README dla wszystkich moich projektów niezależnie od mojego kodu, ale nadal przechowuję je wszystkie w jednym miejscu . Nie są wymagane żadne problemy, gałęzie ani inne łatwe do umieszczenia artefakty.
źródło