是否可以在一个GitHub存储库的README文件中放置一个截图?语法是什么?


当前回答

尽管已经有了一个公认的答案,我想添加另一种方式来上传图片到GitHub上的自述。

你需要在你的回购中制造问题 拖放在评论区你的图像 图像链接生成后,将其插入到自述文件中

更多细节你可以在这里找到

其他回答

如果您使用Markdown (README.md):

如果你有图片在你的repo,你可以使用一个相对URL:

![Alt text](/relative/path/to/img.jpg?raw=true "Optional Title")

如果您需要嵌入托管在其他地方的图像,则可以使用完整的URL

![Alt text](http://full/path/to/img.jpg "Optional title")

GitHub建议使用带?raw=true参数的相对链接,以确保fork回购点正确。

raw=true参数的存在是为了确保你链接到的图像将会按原样呈现。这意味着只有图像将被链接,而不是相应文件的整个GitHub界面。更多细节请看这条评论。

请看一个例子:https://raw.github.com/altercation/solarized/master/README.md

如果你使用svg,那么你也需要将sanitize属性设置为true: ?raw=true&sanitize=true。(感谢@EliSherer)

另外,README文件中有关相对链接的文档:https://help.github.com/articles/relative-links-in-readmes

当然还有降价文档:http://daringfireball.net/projects/markdown/syntax

此外,如果您创建了一个新的分支屏幕截图来存储图像,您可以避免它们在主工作树中

然后你可以使用以下方法嵌入它们:

![Alt text](/../<branch name>/path/to/image.png?raw=true "Optional Title")

我发现在我的repo图像的路径是不够的,我必须链接到raw.github.com子域上的图像。

网址格式https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}

降价示例![设置窗口](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)

从2021年3月起,现在支持:

将文件附加到标记文件

You can now attach files, including images, to markdown files while you're editing them in the web. This works just like file attachments in issues and pull requests and supports the same file types. Just drag and drag, click and select, or paste. Note: If you add an image to a markdown file, anyone can view the anonymized image URL without authentication, even if the markdown file is in a private repository. To keep images private, serve them from a private network or server that requires authentication. For more information on anonymized URLs see "About anonymized image URLs".

我的图像在名称中有空格,例如,粘贴图像20221006123035.png,这导致了我的问题,我失去了一些时间来修复它。如果有人有同样的问题,那么下面是步骤

我通过上传选项上传了图像 然后在网站的文件浏览UI中点击图片。 图像在浏览器中打开。从浏览器的URL复制图像的URL。您可以复制整个路径,或相对于您的.md文件 现在像这样插入。md文件的链接![概述](粘贴%20image%2020221006123035.png)

方法1->降价方式

![Alt Text](https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH})

方法2->HTML方式

<img src="https://link(format same as above)" width="100" height="100"/>

or

<img src="https://link" style=" width:100px ; height:100px " />

如果你不想样式你的图像,即调整大小,删除样式部分