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

其他回答

如果你不想用这些图片“搅乱”你的分支的内容,而且链接是绝对的对你来说也不是问题,那么我建议使用一个单独的孤立分支来存储这些图片。在这种情况下,图像将与回购集成,但不包含在主要内容中。此外,您可以对较大的文件使用LFS(所有主要的git主机都支持LFS)。

可以在命令行中轻松创建孤立分支:

git checkout --orphan images
git reset --hard
cp /path/to/your/image.jpg ./image.jpg
git add --all
git commit -m "Add some images"
git checkout master
git log -n 3 --all --graph

如果一切正常,请推送新分支:

git push -u origin images

然后使用图像的原始github URL。

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

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



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

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

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

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

只需在README.md中添加一个<img>标记,并将相对src添加到存储库。如果您没有使用相对src,请确保服务器支持CORS。

它之所以有效,是因为GitHub支持内联html

<img src="/docs/logo.png" alt="My cool logo"/>
# My cool project and above is the logo of it

在此处观察

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