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

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

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

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


当前回答

在新的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或任何其他我可以发布我的包的地方正确地看到我的图像。

您还可以像任何其他格式一样在markdown文件中插入动画SVG图像。它可以很好地替代GIF图像。

![image description](relative/path/in/repository/to/image.svg)
OR
<img src="relative/path/in/repository/to/image.svg" width="128"/>

示例(假设图像位于存储库中的assets目录中):

![My animated logo](assets/my-logo.svg)

结果:


要使用基于GitHub深色/浅色主题的不同图像,请参阅本文。

如果您需要上传一些图片用于文档,一个不错的方法是使用git-lfs。假设您已安装git-lfs,请执行以下步骤:

初始化每个图像类型的git-lfs:数字lfs*.png数字lfs*.svg数字lfs*.gifgit-lfs*.jpggit-lfs*.jpeg创建一个将用作图像位置的文件夹,例如doc。在基于GNU/Linux和Unix的系统上,这可以通过以下方式完成:cd项目文件夹mkdir文档git添加文档复制粘贴任何图像到文档文件夹。然后通过gitadd命令添加它们。提交并推送。图片可在以下url中公开获取:https://media.githubusercontent.com/media/^github_username^/^repo^/^branch^/^image_location在repo中^

哪里:*^github_username^是github中的用户名(您可以在配置文件页面中找到)*^repo_name^是存储库名称*^branch^是上载图像的存储库分支*^image_location in the repo ^是包含存储图像的文件夹的位置。

此外,您还可以先上传图像,然后访问项目github页面中的位置并浏览,直到找到图像,然后按下下载按钮,然后从浏览器的地址栏复制粘贴url。

将我的项目作为参考。

然后,您可以使用上面提到的markdown语法使用url来包含它们:

![some alternate text that describes the image](^github generated url from git lfs^)

让我们假设我们使用这张照片,然后你可以使用markdown语法:

![In what order to compile the files](https://media.githubusercontent.com/media/pc-magas/myFirstEnclave/master/doc/SGX%20Compile%20workflow.png)

我们可以简单地做到这一点,

在GitHub上创建新问题在Issue的body div上拖放图像

几秒钟后,将生成一个链接。现在,复制链接或图像URL并使用任何支持的平台。

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

![可选文本](../master/myFolder/image.png)