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

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

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

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


当前回答

在最新的Github中,我尝试了以上所有方法,但未能在自述文件页面上显示图像。如果是公共回购,我发现最好的方法是对master或main分支使用githubpages,然后引用自述文件中的链接。

步骤:

在您的存储库中,转到“代码和自动化”下的设置->选择页选择回购的来源和分支,然后单击保存

现在您的repo应该托管在(https://*username*.github.io/*repone*/)上

现在,您可以通过

![Preview Image](https://*username*.github.io/*reponame*/images/logo.PNG)

其他回答

最新的

Wiki可以显示PNG、JPEG或GIF图像

现在您可以使用:

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

-OR-

遵循以下步骤:

在GitHub上,导航到存储库的主页面。在存储库名称下,单击Wiki。使用wiki侧栏,导航到要更改的页面,然后单击“编辑”。在wiki工具栏上,单击“图像”。在“插入图像”对话框中,键入图像URL和替代文本(搜索引擎和屏幕阅读器使用)。单击“确定”。

参考文件。

在新的Github UI中,这对我有用-

示例-在文件夹(myFolder)中提交image.png,并在README.md中添加以下行:

![Optional Text](../main/myFolder/image.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.md文件中写下代码[Anyname](图像路径)

![Screenshot](screenshot1.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工作所必需的。