是否可以在一个GitHub存储库的README文件中放置一个截图?语法是什么?
当前回答
用于显示图像的markdown语法确实是:
![image](https://{url})
但是:如何提供url ?
你可能不想用截图把你的回购弄得乱七八糟,它们和代码没有任何关系 你可能不想处理把你的图片放到网上的麻烦。(上传到服务器…).
所以…你可以使用这个很棒的技巧让github托管你的图像文件。TDLR:
在回购的问题列表上创建一个问题 在这个问题上拖放你的截图 复制标记代码,github刚刚为你创建显示你的图像 将其粘贴到您的自述文件(或任何您想要的地方)
http://solutionoptimist.com/2013/12/28/awesome-github-tricks/
其他回答
如果您使用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的根目录下创建一个目录(文件夹),其中将包含您想要添加的屏幕截图。让我们把这个目录的名称称为屏幕截图。将你想要添加的图片(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会自动为你安排它们。
最后,提交您的更改并发布它!
使用位于/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>
[截图](截图.png)就像上面提到的那样。将截图.png替换为您在存储库中上传的图像的名称。
但当你上传图片时,这里有一个新手提示(我自己也犯了这个错误):
确保映像名称不包含空格。我的原始图片被保存为“截图日月年id.png”。如果您不将名称更改为类似contenttofimage .png的名称,那么它将不会作为图像出现在自述文件中。
用于显示图像的markdown语法确实是:
![image](https://{url})
但是:如何提供url ?
你可能不想用截图把你的回购弄得乱七八糟,它们和代码没有任何关系 你可能不想处理把你的图片放到网上的麻烦。(上传到服务器…).
所以…你可以使用这个很棒的技巧让github托管你的图像文件。TDLR:
在回购的问题列表上创建一个问题 在这个问题上拖放你的截图 复制标记代码,github刚刚为你创建显示你的图像 将其粘贴到您的自述文件(或任何您想要的地方)
http://solutionoptimist.com/2013/12/28/awesome-github-tricks/
推荐文章
- 使用pandoc从Markdown转换为PDF时设置空白大小
- 如何修复Github页面上的HTTP 404 ?
- 如何显示数学方程在一般github的markdown(不是github的博客)
- 无法推送到远程分支,无法解析到分支
- 使用Markdown的Sphinx而不是reST
- 如何在GitHub上创建自己的存储库?
- Github“更新被拒绝,因为远程包含您在本地没有的工作。”
- 降价和图像对齐
- 如何在不同的用户名下推送到GitHub ?
- 在最初创建提交的GitHub上找到一个Pull Request
- Git凭据助手-更新密码
- 标签和释放的区别是什么?
- 切换到另一个Git标记
- Heroku和GitHub:“项目无法检索,内部服务器错误”
- 将现有项目推到Github