是否可以在一个GitHub存储库的README文件中放置一个截图?语法是什么?
当前回答
2020年6月3日:工作答案-
把你的图片上传到postmage.org 上传图片后复制Github-Markdown-Url 插入你的ReadMe
其他回答
[截图](截图.png)就像上面提到的那样。将截图.png替换为您在存储库中上传的图像的名称。
但当你上传图片时,这里有一个新手提示(我自己也犯了这个错误):
确保映像名称不包含空格。我的原始图片被保存为“截图日月年id.png”。如果您不将名称更改为类似contenttofimage .png的名称,那么它将不会作为图像出现在自述文件中。
Markdown: !黑“更加铝(http://url/to/img.png)
创建一个关于添加图像的问题 通过拖放或文件选择器添加图像 然后复制图像源 现在添加到您的README。md文件
完成了!
或者,你也可以使用一些图像托管网站,如imgur,并获得它的url,并将其添加到你的README。Md文件或者你也可以使用一些静态文件托管。
样品的问题
我的图像在名称中有空格,例如,粘贴图像20221006123035.png,这导致了我的问题,我失去了一些时间来修复它。如果有人有同样的问题,那么下面是步骤
我通过上传选项上传了图像 然后在网站的文件浏览UI中点击图片。 图像在浏览器中打开。从浏览器的URL复制图像的URL。您可以复制整个路径,或相对于您的.md文件 现在像这样插入。md文件的链接
如果您使用Markdown (README.md):
如果你有图片在你的repo,你可以使用一个相对URL:

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

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
此外,如果您创建了一个新的分支屏幕截图来存储图像,您可以避免它们在主工作树中
然后你可以使用以下方法嵌入它们:

从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".
推荐文章
- 了解Git和GitHub的基础知识
- 在GitHub上有一个公共回购的私人分支?
- 只用GitHub动作在特定分支上运行作业
- Git合并与强制覆盖
- 是否有一个链接到GitHub下载文件的最新版本的存储库?
- GitHub -致命:无法读取用户名https://github.com':没有这样的文件或目录
- Github:我能看到回购的下载数量吗?
- 如何运行一个github-actions步骤,即使前一步失败,同时仍然失败的工作
- 当我试图推到原点时,为什么Git告诉我“没有这样的远程‘原点’”?
- 在GitHub repo上显示Jenkins构建的当前状态
- 如何取消在github上的拉请求?
- HEAD和master的区别
- 在另一个目录中运行操作
- GitHub克隆与OAuth访问令牌
- 我可以在GitHub上对要点进行拉请求吗?