如何在GitHub的README.md文件中添加图片?

3286

最近我加入了 GitHub,在那里托管了一些项目。

我需要在 README 文件中包含一些图片,但不知道该如何操作。

我搜索了一下,但得到的都是一些链接,告诉我“将图片托管在网络上,并在 README.md 文件中指定图片路径”。

是否有不依赖第三方网络托管服务的方法?


11
重复的问题,已于2012年在https://dev59.com/3mkw5IYBdhLWcg3wBl-A发布。 - leetNightshade
225
不离题,GitHub 是程序员的工具。 - Lance Roberts
6
可能是 如何在 GitHub 仓库的 README 中添加截图? 的重复问题。 - Marcus
https://stackoverflow.com/a/77319849/4393351 - undefined
46个回答

2
从上传文件选项中向您的存储库添加图像,然后在README文件中引用。
![Alt text]("enter repository image URL here") 

1
在最新的Github中,我尝试了所有上述方法,但无法在自述文件页面上显示图像。如果是公共存储库,则最好使用githubpages作为主分支或主分支,并在自述文件中引用链接。
步骤:
  • 在您的存储库中转到设置 -> 在代码和自动化下选择页面
  • 选择您的存储库的源和分支,然后单击保存

现在您的存储库应托管在(https://*username*.github.io/*reponame*/)

现在您可以通过以下方式简单地添加图像

![Preview Image](https://*username*.github.io/*reponame*/images/logo.PNG)

1

如果您想展示托管在任何网站上的图片(例如url为“http://abc.def.com/folder/image.jpg”),那么在您的README.md文件中使用以下语法:

![alt text](<http://abc.def.com/folder/image.jpg>)

  • 只需在浏览器中浏览到该图片(可能是通过单击图片)。它可以是任何网站,包括您自己或其他人托管的github图片。
  • 从浏览器地址栏中复制url,这是您在上述引用语法中要使用的“image_url”。

对于托管在您自己的 Github 存储库中的图像,除了上述 URL 格式外,您还可以使用相对路径。
![alt text](<path_relative_to_current_github_location/image.jpg>)


如果图像位于与 README.md 文件相同的文件夹中(相对路径 URL 的特殊情况),则可以使用:
![alt text](<image.jpg>)


请注意角括号"<"">"将URL括起来。有时这些是必需的,才能使URL正常工作。

1
我们可以很简单地实现这个功能,
  • 在GitHub上创建一个新的Issue
  • 将图片拖放到Issue的正文
几秒钟后,将生成一个链接。现在,复制链接或图像URL,并将其用于任何支持的平台。

1

您还可以将图片放置在Read Me文件的适当位置。


2
只有在直接在Github上使用编辑器时,此方法才有效。 - DarkWiiPlayer

0

如果您不想在分支的内容中“搞乱”这些图像,并且链接是绝对的,那么我建议使用一个单独的孤立分支来存储这些图像。在这种情况下,图像将与存储库集成,但不包含在主要内容中。此外,您可以使用LFS处理较大的文件(所有主要的git主机都支持LFS)。

您可以在命令行轻松创建孤立分支:

git checkout --orphan images
git reset --hard
cp /path/to/your/image.jpg ./image.jpg
git add --all
git commit -m "Add some images"
git checkout master
git log -n 3 --all --graph

如果一切正常,就推送新分支:
git push -u origin images

然后使用图片的原始 Github URL。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接