是否可以将屏幕快照放置在GitHub存储库中的README文件中?语法是什么?
是否可以将屏幕快照放置在GitHub存储库中的README文件中?语法是什么?
Answers:
如果您使用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
以确保正确的分叉存储库点。
该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
此外,如果您创建一个新分支screenshots
来存储图像,则可以避免将它们放入master
工作树中
然后,您可以使用以下方法嵌入它们:
![Alt text](/../<branch name>/path/to/image.png?raw=true "Optional Title")
/relative/path/to/img.jpg
,由于斜杠不是一个绝对的路径吗?
raw=true
参数用于渲染GitHub路径指向的图像,而不是GitHub接口。尝试看看区别:github.com/altercation/solarized/blob/master/img/…与github.com/altercation/solarized/blob/master/img/…。第一个URL将显示GitHub界面和图像,第二个URL仅显示图像。相对链接在克隆/分叉存储库时仍然有用,因此,应该使用带有该参数的相对路径,但是它们是两个不同的概念。
我发现回购中映像的路径不足,我必须链接到raw.github.com
子域上的映像。
网址格式 https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}
降价示例 ![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)
raw.github.com
子域上的图像?在哪里上传图像文件?
下面的一行应该是您想要的
如果您的文件在存储库中
![ScreenShot](https://raw.github.com/{username}/{repository}/{branch}/{path})
如果您的文件在其他外部网址中
![ScreenShot](https://{url})
用于显示图像的markdown语法确实是:
![image](https://{url})
但:如何提供url
?
所以...您可以使用这个很棒的技巧使github托管您的图像文件。TDLR:
http://solutionoptimist.com/2013/12/28/awesome-github-tricks/
将此添加到自述文件
<div align="center">
<img src="/screenshots/screen1.jpg" width="400px"</img>
</div>
首先,在本地存储库的根目录中创建一个目录(文件夹),其中将包含screenshots
要添加的目录。我们称这个目录的名称screenshots
。将要添加的图像(JPEG,PNG,GIF等)放入此目录。
其次,您需要在自述文件中添加每个图像的链接。因此,如果我的图片名为,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会自动为您安排它们。
最后,提交您的更改并推动它!
我在Google上搜索了一些类似的问题,但没有看到关于我的问题及其相当简单/容易解决方案的任何答案。
就像OP一样,我想在我的Github README中添加一个图像,然后知道Markdown语法,将其输入:
![My Image](https://storage.cloud.google.com/${MY_BUCKET}/${MY_IMAGE}
您需要完成上面的实际替换(例如MY_IMAGE = image.jpg),此功能才能起作用。
但是,等等...失败-没有实际的渲染照片!链接与Google Storage给出的完全一样!
camo
匿名图片Github匿名托管您的图片,是的!但是,这为Google存储资产带来了问题。您需要从Google Cloud Console获取生成的网址。
我敢肯定有一种更平滑的方法,但是,只需访问您给定的URL端点并复制长URL。细节:
https
not” 开头的gs
到新的浏览器标签/窗口中希望这有助于加快速度,并为其他人澄清这个问题。
对我来说最好的方法是-
希望这会有所帮助。
从上传文件选项在存储库中添加图像,然后在自述文件中添加图像
![Alt text]("enter image url of repositoryhere")
图像位于/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>
[Read more words!](docs/more_words.md)