是否可以在一个GitHub存储库的README文件中放置一个截图?语法是什么?
当前回答
从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".
其他回答
如果您使用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")
从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".
对我来说,相对路径非常有效。
我是怎么做到的: 在我当前的md文件中,我想使用来自另一个目录的图片,我使用了这样的相对路径-考虑以下点。
Md文件loc: base dir -> _post -> current_file.md
&图片文件loc,我想使用:基础dir -> _asset -> picture_to_use.jpeg
我使用的语句是在current_file上。md文件:
![your-pic-caption-name](../_asset/picture_to_use.jpeg)
注意-在此之前,我使用的是direct _asset,但理想情况下,它从../_asset/and-so-no开始
参考资料- https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes
比添加URL简单多了 只要上传一张图片到同一个存储库, 如:
(截图)! (screenshot.png)
[截图](截图.png)就像上面提到的那样。将截图.png替换为您在存储库中上传的图像的名称。
但当你上传图片时,这里有一个新手提示(我自己也犯了这个错误):
确保映像名称不包含空格。我的原始图片被保存为“截图日月年id.png”。如果您不将名称更改为类似contenttofimage .png的名称,那么它将不会作为图像出现在自述文件中。
推荐文章
- 在Markdown中创建一个没有标题的表
- 强制LF eol在git的回购和工作副本
- 防止在GitHub上推送到master ?
- 我如何在github上引用特定问题的评论?
- 我如何才能看到我在Github上看到的所有问题?
- R -降价避免包装加载消息
- 在GitHub上链接到其他Wiki页面?
- 你如何跟踪你对GitHub问题的评论?
- 我如何在GitHub中为其他人的代码做出贡献?
- GitHub项目和里程碑之间的区别/关系是什么?
- gitignore是什么?
- 在MarkDown中包含SVG(托管在GitHub上)
- 新Github项目发布通知?
- 如何在本地删除分支?
- GitHub.com的存储库大小限制