最近我加入了GitHub。我在那里主持了一些项目。
我需要在README文件中包含一些图像。我不知道该怎么做。
我搜索了一下,但得到的只是一些链接,告诉我“在web上托管图像并在README.md文件中指定图像路径”。
是否有任何方法可以在不在任何第三方网络托管服务上托管图像的情况下做到这一点?
最近我加入了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(此处)中使用项目中的图像
其他回答
如果添加多个屏幕截图并希望使用表格数据对齐它们以提高可访问性,请考虑使用表格,如下所示:
如果markdown解析器支持它,您还可以将role=“presentation”WIA-ARIA属性添加到TABLE元素,并省略th标记。
如果你不想用这些图片“搅乱”你的分支的内容,而且链接是绝对的对你来说也不是问题,那么我建议使用一个单独的孤立分支来存储这些图片。在这种情况下,图像将与回购集成,但不包含在主要内容中。此外,您可以对较大的文件使用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。
我需要在README文件中包含一些图像。我不知道该怎么做这样做。
我创建了一个小向导,允许您为GitHub存储库的自述文件创建和自定义简单的图像库:请参阅ReadmeGalleryCreatorForGitHub。
该向导利用了GitHub允许img标签出现在README.md中的事实。此外,该向导还利用了将图像上传到GitHub的流行技巧,方法是将图像拖放到问题区域(如本主题的一个答案中所述)。
我通常在网站上托管图像,这可以链接到任何托管图像。把这个放在自述文件里。适用于.rst文件,不确定.md
.. image:: https://url/path/to/image
:height: 100px
:width: 200 px
:scale: 50 %
您可以创建新问题上传(拖放)图像到它复制图像URL并将其粘贴到README.md文件中。
下面是一个详细的youTube视频,详细解释了这一点:
https://www.youtube.com/watch?v=nvPOUdz5PL4