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


当前回答

使用位于/screen-shots目录中的图像。外部的<div>允许图像被定位。填充是使用<img width="desired-padding" height="0">实现的。

<div align="center">
        <img width="45%" src="screen-shots/about.PNG" alt="About screen" title="About screen"</img>
        <img height="0" width="8px">
        <img width="45%" src="screen-shots/list.PNG" alt="List screen" title="List screen"></img>
</div>

其他回答

对我来说,相对路径非常有效。

我是怎么做到的: 在我当前的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

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

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

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

我发现在我的repo图像的路径是不够的,我必须链接到raw.github.com子域上的图像。

网址格式https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}

降价示例![设置窗口](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)

我在谷歌上搜索了一些类似的问题,没有看到任何关于我的问题的答案,而且它非常简单/容易解决。

云存储——在readme中处理图像的方法略有不同

就像OP一样,我想在我的Github README中有一张图像,并且,知道这样做的Markdown语法,输入它:

![My Image](https://storage.cloud.google.com/${MY_BUCKET}/${MY_IMAGE}

您需要完成上面的实际替换(例如MY_IMAGE=image.jpg)才能使其工作。

但是,等待…失败——没有实际渲染的照片!和链接是完全由谷歌存储!

Github迷彩-匿名图像

Github匿名托管你的图片,耶!但是,这就为谷歌存储资产带来了一个问题。您需要从谷歌云控制台获取生成的url。

我相信有一个更流畅的方法,但是,只需访问您给定的URL端点并复制长URL。细节:

指令

访问您的存储控制台:https://console.cloud.google.com/storage/browser/${MY_BUCKET}?project=${MY_PROJECT} 点击你想要在Github中显示的图像(这会弹出“对象详细信息”页面) 复制pasta的URL(以https开始,而不是gs)到一个新的浏览器选项卡/窗口 复制pasta新生成的URL -它应该更长-从你的新浏览器选项卡/窗口到你的Github README文件

希望这有助于加快和澄清这个问题的其他人。

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