是否可以将屏幕截图放在 GitHub 存储库的 README 文件中?语法是什么?
如果您使用 Markdown (README.md):
如果您的存储库中有图像,则可以使用相对 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来确保分叉的 repos 正确指向。
?raw=true
该raw=true参数是为了确保您链接到的图像将按原样呈现。这意味着只有图像将被链接到,而不是相应文件的整个 GitHub 界面。
raw=true
查看一个示例:https ://raw.github.com/altercation/solarized/master/README.md
如果您使用 SVG,那么您还需要将 sanitize 属性设置true为:?raw=true&sanitize=true. (感谢@EliSherer)
true
?raw=true&sanitize=true
此外,关于 README 文件中的相对链接的文档:https ://help.github.com/articles/relative-links-in- readmes
当然还有降价文档:http ://daringfireball.net/projects/markdown/syntax
此外,如果您创建一个新分支screenshots来存储图像,您可以避免它们在master工作树中
screenshots
master
然后,您可以使用以下方法嵌入它们:
![Alt text](/../<branch name>/path/to/image.png?raw=true "Optional Title")