github 自述文件
示例
如果您的项目没有README.md，则GitHub可能会解析README.rdoc以显示详细信息。如果两者兼有，它将使用README.md，而忽略了rdoc。
自述文件可能包括-
项目名称
简要描述您的项目。您还可以提供项目的网站链接，徽章，社区和联系信息（即电子邮件，社交网站）。
下载
可运行文件（可执行文件或压缩文件或安装文件）链接。也可以有到以前版本的链接。
安装
如何使用您的工作。它可能包括先决条件，设置，第三方库，用法，注意事项等。
示范
它可能包括代码示例，gif文件，视频链接，甚至是屏幕截图。
s
作者姓名，联系方式等
致谢
在整个项目中得到帮助和启发的人员或社区清单
贡献
为项目做出贡献的说明（即添加功能，报告错误，提交补丁）。也可能包括文档链接。
执照
简要介绍您的许可证。您也可以提供指向许可证站点的链接。
-
我试图在中嵌入一个图像，以便在GitHub上显示。我以前在使用公共存储库时没有遇到过这样的问题，格式如下：
-
我的项目下划线cli有一个文件，我想记录标志。 目前，做到这一点的唯一方法是使用屏幕截图（可以存储在项目存储库中）： 但是屏幕截图不是文本，这会阻止读者在屏幕截图中复制/粘贴命令。它们的创建/编辑/维护也很麻烦，而且浏览器加载速度较慢。现代网络使用文本样式，而不是一堆文本的渲染图像。 虽然一些Markdown解析器支持内联超文本标记语言样式，但GitHub不支持；这不起作用： 这不管用：
-
我有以下表情符号，当在markdown中使用时，它会转换为星星表情符号，我希望它们在自述文件中居中对齐。 我曾经用过 但这是行不通的。
-
我将屏幕截图()存储在单独的Git分支()中，用于Readme.md文件(分支上）。 要在GitHub上看到图片，我必须链接到： 或 但是，当在本地查看自述文件时这就不起作用了，图像不显示（比如在VS代码或Atom中使用Markdown预览特性时）。 我甚至使用了git worktree特性来检查assets子目录中的assets分支： 目录结构如下所示： 是否有一种方法可以链接到屏幕截图，使其始
-
我有驱动器中的图像，如何将其添加到Readme.md，以便在自述文件中显示图像。我尝试了共享链接，但它不工作。
-
是否可以将屏幕截图放在GitHub存储库中的自述文件中？语法是什么？