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


当前回答

Markdown: !黑“更加铝(http://url/to/img.png)

创建一个关于添加图像的问题 通过拖放或文件选择器添加图像 然后复制图像源 现在添加![截图](http://url/to/img.png)到您的README。md文件

完成了!

或者,你也可以使用一些图像托管网站,如imgur,并获得它的url,并将其添加到你的README。Md文件或者你也可以使用一些静态文件托管。

样品的问题

其他回答

如果您使用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)

请休息这四步, 这对我很有效

1-在GitHub上创建一个新问题。 拖放图片到评论栏或上传照片。 3 .等待上传完成。 4 .复制URL并在GitHub上的Markdown文件中使用它(在存储库的自述中使用生成的URL)。

[截图](截图.png)就像上面提到的那样。将截图.png替换为您在存储库中上传的图像的名称。

但当你上传图片时,这里有一个新手提示(我自己也犯了这个错误):

确保映像名称不包含空格。我的原始图片被保存为“截图日月年id.png”。如果您不将名称更改为类似contenttofimage .png的名称,那么它将不会作为图像出现在自述文件中。

在存储库中从上传文件选项添加图像,然后在README文件中

![Alt text]("enter image url of repositoryhere")