最近我加入了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 UI中,这对我有用-

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

![Optional Text](../main/myFolder/image.png)

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

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

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

我现在可以在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>

你可以这样做:

git checkout --orphan assets
cp /where/image/currently/located/on/machine/diagram.png .
git add .
git commit -m 'Added diagram'
git push -u origin assets

然后,您可以在README文件中引用它,如下所示:

![diagram](diagram.png)

创建有关添加图像的问题通过拖放或文件选择器添加图像然后复制图像源现在添加![替换标签](http://url/to/img.png)到README.md文件

完成!

或者,您可以使用imgur之类的图像托管站点,获取其url并将其添加到README.md文件中,或者也可以使用一些静态文件托管。

样品问题