如何将图像添加到 GitHub 上的 README.md？

比眉伴天荒 2024-03-30 12:12 60阅读 0赞

## 问： ##

最近我加入了 GitHub。我在那里主持了一些项目。

我需要在我的自述文件中包含一些图像。我不知道该怎么做。

我对此进行了搜索，但我得到的只是一些链接，这些链接告诉我“在网络上托管图像并在 README.md 文件中指定图像路径”。

有没有办法在不将图像托管在任何第三方网络托管服务上的情况下做到这一点？

## 答1: ##

> huntsbot.com汇聚了国内外优秀的初创产品创意，可按收入、分类等筛选，希望这些产品与实践经验能给您带来灵感。

试试这个降价：

![alt text](http://url/to/img.png)

如果图像存储在您的存储库中，我认为您可以直接链接到图像的原始版本。 IE

![alt text](https://github.com/[username]/[reponame]/blob/[branch]/image.jpg?raw=true)

`您还应该考虑使用 relative links`

`相对链接在这里不是很好用，想象你的自述文件也显示在不以这种方式托管图像的 npm 上——它需要链接到 GitHub。图片来源应位于 github.com 域，而不是 raw.github.com 子域和 raw.githubusercontent.com 域。`

`实际上我最终选择了相对路径（对我来说这只是图像文件的名称，因为我在根目录中拥有所有内容）。我一直在维护 README.md 的 2 个副本，一个用于 /usr/share/projectname/docs 中的本地安装，另一个用于 github。现在，我可以对两者都使用相同的 README.md，因为图像文件名在这两种情况下都可以正常工作。如果我想在其他地方发布我的 README 的部分副本，我要么必须将图像托管在其他地方，要么放入 raw.github.com 网址。`

`GitHub 自己推荐相对路径：help.github.com/articles/relative-links-in-readmes 绝对路径的一个主要缺点是，如果图像在 master 中移动，仍然指向旧 URL 的其他分支将会中断。`

`当前建议的域似乎不起作用，链接应该是这样的：https://github.com/[username]/[reponame]/blob/[branch]/image.jpg?raw=true`

## 答2: ##

> huntsbot.com汇聚了国内外优秀的初创产品创意，可按收入、分类等筛选，希望这些产品与实践经验能给您带来灵感。

您还可以使用相对路径，例如

![Alt text](relative/path/to/img.jpg?raw=true "Title")

还可以使用所需的 .fileExtention 尝试以下操作：

![plot](./directory_1/directory_2/.../directory_n/plot.png)

`是的。除非您担心性能，否则这是迄今为止最简单的方法。我注意到这是相对于 directory 而不是 repo，所以如果你有 'myimage .png' 在与“about_pics.md”相同的目录中，则标记为：![What is this](myimage.png)`

`这是一个很棒的解决方案，因为 1）它可以工作 2）图像也显示在本地查看器中，无需互联网访问`

`@Rich 您能否扩展您对性能的评论。相对路径方法存在哪些性能问题？`

`这个路径是相对于什么的？`

`正如 Lee Crossley 所指出的，您应该避免相对链接，因为当您的自述文件显示在 npm 上时它们会中断。相反，如果图像格式类似于 SVG，则使用“?sanitize=true”标志链接到 github.com 域上的图像 src。在这个 SO 答案中查看更多详细信息：stackoverflow.com/a/16462143/6798201`

## 答3: ##

> HuntsBot周刊–不定时分享成功产品案例，学习他们如何成功建立自己的副业–huntsbot.com

您可以创建一个新问题

上传（拖放）图像到它

复制图像 URL 并将其粘贴到您的 README.md 文件中。

这是一个详细的youtube视频，详细解释了这一点：

https://www.youtube.com/watch?v=nvPOUdz5PL4

`据我了解，您实际上并不需要保存该问题。这样，您就不需要问题跟踪器中的那些虚拟票证。问题是这是否是一种“安全”的方法，这意味着 GitHub 是否会（在一段时间后）检测到该图像是孤立的并因此将其从 GitHub CDN 中删除？`

`这个答案对我来说非常有效，不需要在回购中保存新问题。我在 Youtube 上找到了一个视频，详细解释了这一点：youtube.com/watch?v=nvPOUdz5PL4。`

`这个答案有效，并且需要很少的努力。可以放弃该问题，但图像的 URL 仍然存在。图片 URL 的格式为：user-images.githubusercontent.com...`

`这是一个很棒的技巧！但是有人知道@peterh 问题的答案吗？ GitHub 会定期清除孤立的图像（即没有附加问题）吗？`

`@JohnnyOshika 我怀疑 github 之外的任何人都可以明确回答这个问题。它可能取决于“user-images.githubusercontent.com”的用途。如果仅针对上传到评论的图像，那么他们可以扫描丢失的数据关系并删除图像是合理的。如果它更一般，可能很难确定没有对该文件的引用，这使得确定它可以毫无问题地删除它要么计算量大，要么具有挑战性。`

## 答4: ##

> huntsbot.com提供全网独家一站式外包任务、远程工作、创意产品分享与订阅服务!

它比这简单得多。

只需将您的图像上传到存储库根目录，并链接到不带任何路径的文件名，如下所示：

![Screenshot](screenshot.png)

`不，我不认为将屏幕截图添加到 git 存储库是一个好习惯。尤其是不在根源上。 Ahmad Ajmi 的回答要好得多`

`不在根目录，但您可以轻松地将其调整为 docs/images 或其他任何内容，小 png 屏幕截图可以恕我直言`

`这应该是公认的解决方案，尤其是。 Christophe 建议将图像放在 doc/ tree/ 下`

`完美的..！！如果 png 在另一个文件夹中。只需添加路径“folderName/screenshot.png”`

`我发现您的回答对我的案例很有用：我在 Gitlab 上，我在 repo 的根目录中使用 logo.png 图片为 repo 设置头像。我想将这张照片包含在 README.md 中。`

## 答5: ##

> huntsbot.com提供全网独家一站式外包任务、远程工作、创意产品分享与订阅服务!

您还可以使用简单的 HTML 标签添加图像：

`当您在降价文件中使用 HTML 标记时。通用文档转换器 Pandoc 将忽略它。`

`这是最好的，因此它可以居中或放置在一侧（至少对于较小的图像。）`

`你如何指定相对路径？它与 README.md 无关（在所有情况下？）。`

## 答6: ##

> huntsbot.com洞察每一个产品背后的需求与收益，从而捕获灵感

许多发布的解决方案都不完整或不符合我的口味。

像 imgur 这样的外部 CDN 为链添加了另一个工具。嗯。

在问题跟踪器中创建一个虚拟问题是一种 hack。它会造成混乱并使用户感到困惑。将此解决方案迁移到 fork 或从 GitHub 迁移是一件痛苦的事情。

使用 gh-pages 分支会使 URL 变得脆弱。另一个在维护 gh-page 的项目上工作的人可能不知道外部的东西取决于这些图像的路径。 gh-pages 分支在 GitHub 上具有特定的行为，这对于托管 CDN 图像不是必需的。

在版本控制中跟踪资产是一件好事。随着项目的发展和变化，它是一种更可持续的方式来管理和跟踪多个用户的变化。

如果图像适用于软件的特定版本，则最好链接不可变图像。这样，如果稍后更新映像以反映对软件的更改，任何阅读该修订版自述文件的人都会找到正确的映像。

受 this gist 启发，我首选的解决方案是使用 assets 分支，并带有特定修订的永久链接。

git checkout --orphan assets
    git reset --hard
    cp /path/to/cat.png .
    git add .
    git commit -m 'Added cat picture'
    git push -u origin assets
    git rev-parse HEAD  # Print the SHA, which is optional, you'll see below.

为这个版本的图像构建一个“永久链接”，并将其包装在 Markdown 中。

然而，手动查找提交 SHA 是不方便的，因此作为该 help.github 页面所述，作为快捷方式按 Y 到特定提交中文件的永久链接。

要始终在资产分支上显示最新图像，请使用 blob URL：

https://github.com/github/{
        repository}/blob/assets/cat.png

（来自同一 GitHub 帮助页面 File views show the latest version on a branch）

`这是对已接受答案的一个很好的补充。资产被跟踪，图像不在母版中，没有混乱。请注意 git reset --hard;确保更改已提交。`

`在你的机器上狂野。您可以将其指向文件所在的位置（~/Downloads、/tmp 等）。`

`我发誓我记得有一个你可以制作的目录不会出现在 Github 上。在我能追查到这一点之前，这篇文章似乎是下一个最好的使用方法。谢谢！`

`我不明白为资产创建新分支有什么好处。为什么不将资产与使用这些资产的文件一起保存在同一个分支中呢？`

`这样就少了些杂乱。`

## 答7: ##

> huntsbot.com汇聚了国内外优秀的初创产品创意，可按收入、分类等筛选，希望这些产品与实践经验能给您带来灵感。

您也可以像任何其他格式一样在降价文件中插入 animated SVG images。它可以很好地替代 GIF 图像。

![image description](relative/path/in/repository/to/image.svg)
    OR

示例（假设图像位于存储库的 assets 目录中）：

![My animated logo](assets/my-logo.svg)

结果：

要使用基于 GitHub 深色/浅色主题的不同图像，请参阅 this post。

## 答8: ##

> huntsbot.com汇聚了国内外优秀的初创产品创意，可按收入、分类等筛选，希望这些产品与实践经验能给您带来灵感。

将您的图像 (image.png) 提交到文件夹 (myFolder) 中，并在 README.md 中添加以下行：

\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-QnwWRVaN-1672015087293)(…/master/myFolder/image.png)\]

## 答9: ##

> huntsbot.com – 高效赚钱，自由工作

我需要在我的自述文件中包含一些图像。我不知道该怎么做。

我创建了一个小向导，允许您为 GitHub 存储库的自述文件创建和自定义简单的图像库：请参阅 ReadmeGalleryCreatorForGitHub。

该向导利用了 GitHub 允许 img 标签出现在 README.md 中的事实。此外，该向导还利用了流行的技巧，即通过将图像拖放到问题区域中来将图像上传到 GitHub（如本主题的答案之一中所述）。

https://i.stack.imgur.com/sMUbB.png

`喜欢这个工具！`

`我也很喜欢这个工具，这应该是 Git 的默认功能！！`

`这太棒了！`

`这真太了不起了！`

## 答10: ##

> 打造属于自己的副业，开启自由职业之旅，从huntsbot.com开始!

非常简单：可以使用 Ctrl + C/V 完成

这里的大多数答案直接或间接涉及将图像上传到其他地方然后提供指向它的链接。

只需复制任何图像并在编辑 Readme.md 时粘贴它就可以非常简单地完成

复制图像 - 您只需单击图像文件并使用 Ctrl + C 或可以使用截图工具将屏幕截图图像复制到剪贴板

然后，您可以在编辑 Readme.md 时简单地执行 Ctrl + V

Guithub 会自动将其上传到 user-images.githubusercontent.com 并在此处插入指向它的链接

> huntsbot.com全球7大洲远程工作机会，探索不一样的工作方式

`真的是最有用的答案。即使我正在寻找这个，但我得到的大多数答案都涉及在问题/回购等地方上传图像并提供指向它的链接。这个真的很有帮助！`

`这对其他人来说可能很明显，但请确保您正在编辑网络上 GitHub 存储库上的 README 文件。它在您的本地 IDE 中不起作用，您必须手动编辑 repo 上的 README 文件，然后拖放。感谢你的回答！`

`这是最好的方式编辑阅读我>复制图片>粘贴>保存`

`我可以确认这有效 - github 中的编辑器非常干净地处理了 cmd+v 并上传了图像`

`这是imo最重要的答案`

## 答11: ##

> 打造属于自己的副业，开启自由职业之旅，从huntsbot.com开始!

创建有关添加图像的问题

通过拖放或文件选择器添加图像

然后复制图片源

现在将 \[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-UeCrkcuk-1672015087785)(null)\] 添加到您的 README.md 文件中

完毕！

或者，您可以使用像 imgur 这样的图像托管网站并获取它的 url 并将其添加到您的 README.md 文件中，或者您也可以使用一些静态文件托管。

Sample issue

`在我看来，这是添加它们的最简单方法。只需将它们拖入框中，复制地址并将其粘贴到您的自述文件中，并附上下面的标题。砰，你已经完成了。`

原文链接：[https://www.huntsbot.com/qa/9rDZ/how-to-add-images-to-readme-md-on-github?lang=zh\_CN&from=csdn][https_www.huntsbot.com_qa_9rDZ_how-to-add-images-to-readme-md-on-github_lang_zh_CN_from_csdn]

> huntsbot.com提供全网独家一站式外包任务、远程工作、创意产品分享与订阅服务!

[https_www.huntsbot.com_qa_9rDZ_how-to-add-images-to-readme-md-on-github_lang_zh_CN_from_csdn]: https://www.huntsbot.com/qa/9rDZ/how-to-add-images-to-readme-md-on-github?lang=zh_CN&from=csdn