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


当前回答

首先,在本地repo的根目录下创建一个目录(文件夹),其中将包含您想要添加的屏幕截图。让我们把这个目录的名称称为屏幕截图。将你想要添加的图片(JPEG、PNG、GIF等)放到这个目录中。

Android Studio工作空间截图

其次,您需要将每个图像的链接添加到README中。所以,如果我的截图目录中有命名为1_ArtistsActivity.png和2_AlbumsActivity.png的图像,我将像这样添加它们的链接:

 <img src="screenshots/1_ArtistsActivity.png" height="400" alt="Screenshot"/> <img src=“screenshots/2_AlbumsActivity.png" height="400" alt="Screenshot"/>

如果你想让每个截图在单独的行上,把它们的链接写在单独的行上。但是,最好将所有链接写在一行中,仅用空格分隔。它可能看起来不太好,但通过这样做,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")

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

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

比添加URL简单多了 只要上传一张图片到同一个存储库, 如:

(截图)! (screenshot.png)

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

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

确保映像名称不包含空格。我的原始图片被保存为“截图日月年id.png”。如果您不将名称更改为类似contenttofimage .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".