最近我加入了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(此处)中使用项目中的图像

其他回答

您可以使用

![A test image](image.png)

哪里[A test image]是您的alt文本,(image.png)是您图像的链接。


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


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

现在,您可以在编辑自述文件时拖放图像。

Github将为您创建一个链接,其格式为:

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

或者,在文件的底部,它会显示“通过拖放、选择或粘贴来附加文件”。如果你点击那个,它会给你一个直接上传文件的选项,或者你可以直接粘贴它!

我找到了另一个解决方案,但完全不同,我会解释一下

基本上,我使用标签来显示图像,但我想在单击图像时转到另一个页面,下面是我是如何做到的。

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

如果你把它放在彼此的旁边,用一条新的线隔开,我猜当你点击图片时,它会转到一个标签,标签上有你想要重定向的另一个站点的href。

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

我尝试了几种方法,最后这对我有用:

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

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

您可以创建新问题上传(拖放)图像到它复制图像URL并将其粘贴到README.md文件中。

下面是一个详细的youTube视频,详细解释了这一点:

https://www.youtube.com/watch?v=nvPOUdz5PL4