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

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

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

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


当前回答

如果您需要上传一些图片用于文档,一个不错的方法是使用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)

其他回答

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

如果您想显示任何网站上托管的图像(假设url为“http://abc.def.com/folder/image.jpg”),那么在README.md文件中使用以下语法:![alt-text](<http://abc.def.com/folder/image.jpg>)

只需在浏览器中浏览图像(可以通过单击图像)。它可以是任何网站,包括你的或其他人的github托管图像。从浏览器地址栏中复制url,即要在上述语法中使用的“image_url”。


对于托管在您自己的github存储库中的图像,除了上述url格式之外,您还可以使用相对路径![alt-text](<path_relative_to_current_github_location/image.jpg>)如果图像与README.md文件位于同一文件夹中(相对路径url的特殊情况),则可以使用:![alt-text](<image.jpg>)


注意url周围的尖括号“<”和“>”。有时,这些是url工作所必需的。

在新的Github UI中,这对我有用-

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

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

非常简单:可以使用Ctrl+C/V完成

这里的大多数答案都是直接或间接地将图像上传到其他地方,然后提供链接。

只需复制任何图像并在编辑Readme.md时粘贴即可完成

复制图像-您只需单击图像文件并使用Ctrl+C,也可以使用剪切工具将截图图像复制到剪贴板然后,您可以在编辑Readme.md时简单地按Ctrl+V

Guithub将自动将其上传到user-images.githubusercontent.com,并在那里插入指向它的链接

您还可以像任何其他格式一样在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深色/浅色主题的不同图像,请参阅本文。