GitHub 中 readme 如何添加圖片


一、Readme 是什么

readme文件一般是放在github 每個repo的根目錄下,用來解釋、說明本repo的主要內容和相關信息。而且在repo主頁進去的時候會被自動加載。一般采用md標記的文本格式。

二、一些嘗試

md格式的文本插入圖片格式一般是:

![說明文字](圖片地址)

說明文字在github中一般不被顯示出來 —— 但不意味着其他APP解析的時候不顯示,要根據情況,比如簡書的就會顯示。

這種圖片顯示的核心,在於地址。比如,我的repo目錄clone到本地之后,是d:\myproject\ 這個文件夾。而我的圖片存放位置是d:\myproject\pics\pic1.png

情況一:絕對路徑

如果我直接在本地的markdown文件中插入以下內容,則顯示正確。

![pic1](d:\myproject\pics\pic1.png)

加載出來之后,就會在文檔中顯示這個圖片。

情況二:相對路徑

由於我的readme.md在d:\myproject\readme.md,所以可以用 . 代替當前目錄,使用以下

![pic1](./pics/pic1.png)

則也顯示正確。

 

但是如果把以上任何一種,push到github中,則都不能正確加載。因為絕對地址是在本地,GitHub的服務器中肯定沒d盤這樣的路徑。而相對路徑看起來可行,但是沒有考慮到git中特殊的文件管理方式。查了文檔之后,正確的方式是這樣。

 

三、正確姿勢

![圖片說明](https://github.com/你的用戶名/你的repository倉庫名/raw/分支名master/剛你新建的圖片文件夾名稱/***.png或者***.jpg)

用這樣的方式,就可以在readme中正確顯示了。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM