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

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

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

是否有任何方法可以在不在任何第三方网络托管服务上托管图像的情况下做到这一点?


当前回答

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

其他回答

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

首先,您应该将图像文件上传到github代码库!然后直接引用图像文件的地址。



我们可以简单地做到这一点,

在GitHub上创建新问题在Issue的body div上拖放图像

几秒钟后,将生成一个链接。现在,复制链接或图像URL并使用任何支持的平台。

如果您需要上传一些图片用于文档,一个不错的方法是使用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)

如果您想显示任何网站上托管的图像(假设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列|第2列||------------|-------------||图像1 |图像2|

输出

现在,如果使用两个图像,只需在图像1和图像2处放置<img src=“url/relativePath”>

注意:如果使用多个图像只是包含更多列,则可以使用width和height属性使其看起来可读。

实例

|第1列|第2列||------------|-------------||<img src=“https://media.wired.com/photos/5926db217034dc5f91becd6b/master/w_582,c_limit/so-go-s.jpg“width=”250“>|<img src=”https://mk0jobadderjftub56m0.kinstacdn.com/wp-content/uploads/stackoverflow.com-300.jpg“width=”250“>|

间距无关紧要

输出图像

帮助人:adam-p