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


当前回答

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

云存储——在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文件

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

其他回答

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

云存储——在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")

尽管已经有了一个公认的答案,我想添加另一种方式来上传图片到GitHub上的自述。

你需要在你的回购中制造问题 拖放在评论区你的图像 图像链接生成后,将其插入到自述文件中

更多细节你可以在这里找到

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

(截图)! (screenshot.png)

首先,在本地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会自动为你安排它们。

最后,提交您的更改并发布它!