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

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

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

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

有没有办法不用在任何第三方web托管服务上托管图像就可以做到这一点？

试试这个降价：

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

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

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

• 您可以创建一个新问题
• 上传（拖放）图像到它
• 复制图像URL并将其粘贴到README.md文件中

下面是一段详细的youTube视频，详细解释了这一点：

---

我通常在网站上托管图像，这可以链接到任何托管图像。把这个写进自述文件就行了。适用于

.rst

文件，不确定

.md

.. image:: https://url/path/to/image
   :height: 100px
   :width: 200 px
   :scale: 50 %

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

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

该向导利用了GitHub允许img标记出现在

README.md

中这一事实。此外，该向导还利用了将图像上传到GitHub的流行技巧，将图像拖放到问题区域（如本线程中的一个答案所述）

---

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

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

还可以使用所需的

.fileextension

尝试以下操作：

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

基本语法 在这里：

my image alt tag：如果未显示图像，将显示的文本

图像url：无论您的图像资源是什么。图像的URI

例子： 如下所示：

---

您还可以添加带有简单HTML标记的图像：

<p align="center">
  <img src="your_relative_path_here" width="350" title="hover text">
  <img src="your_relative_path_here_number_2_large_name" width="350" alt="accessibility text">
</p>

我已经解决了这个问题。您只需要参考其他人的自述文件

首先，您应该将一个图像文件上载到github代码库！然后直接引用图像文件的地址

比这简单得多。 只需将图像上载到存储库根目录，并链接到文件名，无需任何路径，如下所示：

![Screenshot](screenshot.png)

---

在我的例子中，我想在

Github

上显示一个打印屏幕，但也要在

NPM

上显示。即使使用相对路径在Github中工作，但在它之外也不工作。基本上，即使我把我的项目也推到了

NPM

（它只是使用了相同的

readme.md

），图像也不会显示出来

我尝试了几种方法，最后这是对我有效的方法：

！[预览](https://raw.githubusercontent.com/username/project/master/image-path/image.png)

现在，我可以在

NPM

或我可以发布我的软件包的任何地方正确地看到我的图像。

• 创建有关添加图像的问题
• 通过拖放或文件选择器添加图像
• 然后复制图像源

• 现在添加

  ！[alt tag](http://url/to/img.png)

  到您的README.md文件

完成了

或者，您可以使用一些图像托管站点，如

imgur

，获取其url并将其添加到README.md文件中，或者您也可以使用一些静态文件托管

在我的例子中，我这样使用直接链接

![img](http://i.imgur.com/yourfilename.png)

---

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

• 像imgur这样的外部CDN为chain.Meh添加了另一个工具
• 在问题跟踪器中创建虚拟问题是一种黑客行为。它会造成混乱并迷惑用户。将此解决方案迁移到fork或脱离GitHub是一种痛苦
• 使用gh pages分支会使URL变得脆弱。在维护gh页面的项目中工作的其他人可能不知道外部依赖于这些图像的路径。gh pages分支在GitHub上有一个特定的行为，这对于托管CDN图像是不必要的
• 在版本控制中跟踪资产是一件好事。随着项目的发展和变化，管理和跟踪多个用户的变化是一种更可持续的方式
• 如果某个映像适用于软件的特定版本，则最好链接一个不可变映像。这样，如果以后更新映像以反映软件的更改，则任何阅读该版本自述的人都会找到正确的映像

受启发，我的首选解决方案是使用资产分支，并将永久链接到特定修订版

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.

构造一个“永久链接”到该图像的修订版，并用标记将其包装起来

然而，手工查找commit SHA并不方便，因此，作为一种快捷方式，按Y键可以永久链接到特定commit中的文件

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

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

---

（来自同一GitHub帮助页面）

提交文件夹（myFolder）中的图像（image.png），并在自述文件.md中添加以下行：

---

！[Optional Text]（../master/myFolder/image.png）

如果您需要上传一些图片用于文档，可以使用一种很好的方法。如果您已安装git lfs，请按照以下步骤操作：

为每种图像类型初始化git lfs：

git lfs *.png
git lfs *.svg
git lfs *.gif
git lfs *.jpg
git lfs *.jpeg

创建一个将用作映像位置的文件夹，例如

doc

。在基于GNU/Linux和Unix的系统上，可以通过以下方式完成此操作：

cd project_folder
mkdir doc
git add doc

将任何图像复制粘贴到文档文件夹中。然后通过

git add

命令添加它们

提交并推送

这些图像可在以下url中公开获取：

^github(用户名^/^repo ^/^branch ^/^image)在repo中的位置^

其中： * <

git lfs *.png
git lfs *.svg
git lfs *.gif
git lfs *.jpg
git lfs *.jpeg

cd project_folder
mkdir doc
git add doc

![some alternate text that describes the image](^github generated url from git lfs^)

[[https://github.com/username/repository/blob/master/img/octocat.png|alt=octocat]]

https://cdn.rawgit.com/<USER>/<REPO>/<BRANCH>/<PATH>/<TO>/<FILE>

<img src="/docs/logo.png" alt="My cool logo"/>
# My cool project and above is the logo of it

![Screenshot](screenshot.png)

git checkout --orphan assets
cp /where/image/currently/located/on/machine/diagram.png .
git add .
git commit -m 'Added diagram'
git push -u origin assets

 - `raw.githubusercontent.com/YourUserAccount/YourProject/YourBranch/DirectoryPath/svgdemo1.svg?sanitize=true&raw=true`

**raw.githubusercontent.com**:
<img src="https://raw.githubusercontent.com/YourUserAccount/YourProject/master/DirectoryPath/Example.png?raw=true" />

<img src="https://raw.githubusercontent.com/YourUserAccount/YourProject/master/DirectoryPath/svgdemo1.svg?sanitize=true&raw=true" />

<a href="the-url-you-want-to-go-when-image-is-clicked.com" />
<img src="image-source-url-location.com" />

![alt text](https://raw.githubusercontent.com/my-org/assets/master/folder/logo.png)

![](relative url where images is located/refrence_image.png)  // refrence_image is the name of image in my case.

![](app/src/main/res/drawable/refrence_image.png)

![](app/src/main/res/drawable/refrence_image1.png)
![](app/src/main/res/drawable/refrence_image2.png)
![](app/src/main/res/drawable/refrence_image3.png)

![Optional Text](../main/myFolder/image.png)

https://user-images.githubusercontent.com/******/********.file_format