您可以使用

![A test image](image.png)

哪里[A test image]是您的alt文本，（image.png）是您图像的链接。

您可以将图像放在云服务或其他在线图像托管平台上或者，如果存储库中有图像链接，则可以从存储库中提供图像链接

您还可以在存储库中创建专用于自述文件图像的特定文件夹

在我的例子中，我想在Github上显示打印屏幕，但也在NPM上显示。尽管使用相对路径在Github内部有效，但在Github之外却无法正常工作。基本上，即使我也将项目推到了NPM（它只是使用了相同的readme.md），图像也从未显示。

我尝试了几种方法，最后这对我有用：


我现在可以在NPM或任何其他我可以发布我的包的地方正确地看到我的图像。

您还可以添加带有简单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 CDN链接从README.md（或外部）链接到项目中的图像。

URL将如下所示：

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

我的项目中有一个SVG图像，当我在Python项目文档中引用它时，它不会呈现。

项目链接

以下是文件的项目链接（不渲染为图像）：

https://github.com/jongracecox/anybadge/blob/master/examples/awesomeness.svg

嵌入图像示例：

原始链接

以下是指向文件的RAW链接（仍然无法渲染为图像）：

https://raw.githubusercontent.com/jongracecox/anybadge/master/examples/awesomeness.svg

嵌入图像示例：

CDN链接

使用CDN链接，我可以使用（渲染为图像）链接到文件：

https://cdn.rawgit.com/jongracecox/anybadge/master/examples/awesomeness.svg

嵌入图像示例：

这就是我如何在README.md文件和PyPi项目reStructedText doucmentation（此处）中使用项目中的图像

基本语法

![myimage-alt-tag](url-to-image)

在这里：

my image alt标记：如果未显示图像，将显示的文本。图像的url：无论您的图像资源是什么。图像的URI

例子：

![stack Overflow](http://lmsotfy.com/so.png)

如下所示：