如果您需要上传一些图片用于文档，一个不错的方法是使用git-lfs。假设您已安装git-lfs，请执行以下步骤：

初始化每个图像类型的git-lfs：数字lfs*.png数字lfs*.svg数字lfs*.gifgit-lfs*.jpggit-lfs*.jpeg创建一个将用作图像位置的文件夹，例如doc。在基于GNU/Linux和Unix的系统上，这可以通过以下方式完成：cd项目文件夹mkdir文档git添加文档复制粘贴任何图像到文档文件夹。然后通过gitadd命令添加它们。提交并推送。图片可在以下url中公开获取：https://media.githubusercontent.com/media/^github_username^/^repo^/^branch^/^image_location在repo中^

哪里：*^github_username^是github中的用户名（您可以在配置文件页面中找到）*^repo_name^是存储库名称*^branch^是上载图像的存储库分支*^image_location in the repo ^是包含存储图像的文件夹的位置。

此外，您还可以先上传图像，然后访问项目github页面中的位置并浏览，直到找到图像，然后按下下载按钮，然后从浏览器的地址栏复制粘贴url。

将我的项目作为参考。

然后，您可以使用上面提到的markdown语法使用url来包含它们：

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

让我们假设我们使用这张照片，然后你可以使用markdown语法：

![In what order to compile the files](https://media.githubusercontent.com/media/pc-magas/myFirstEnclave/master/doc/SGX%20Compile%20workflow.png)

基本语法

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

在这里：

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

例子：

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

如下所示：

您可以使用替代的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（此处）中使用项目中的图像

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

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

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

这就行了！！

注意标记中的文件名大写，将PNG文件放入根目录，并链接到没有任何路径的文件名：

![Screenshot](screenshot.png)

如果您想显示任何网站上托管的图像（假设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工作所必需的。