问题标签 [readme]

有没有办法让 Github 上的存储库页面在其顶级文件列表上方显示其 README.md？当列表很长（对于自己的存储库）和浏览他人的存储库时（当自述文件的含义比文件名更多时），滚动过去该列表是乏味的。

每次我将图像拖放到 Github 上项目的问题页面中，然后将链接复制到 Readme.md 文件。这通常有效，但如果我有一些更复杂的标签，则不会显示图像，而是会显示链接。

这是它在Markdown 编辑器中的样子： 这是它在 Github(live) 上的样子： 请注意，MarkDown 编辑器按预期显示图像：

我开发了一个我选择托管的小型库GitHub。该代码由 VSTS 构建构建并作为 NuGet 包发布。

如 Microsoft文档中所述，我已经编写了一个README.md文件，并尝试在其上包含一个 Build 徽章。因此，我在 MD 文件中添加了以下行并相应地替换了占位符：

问题是任何未登录 VSTS 的人都无法访问该链接，并且我的自述文件页面上出现了“损坏”链接：

问题

必须做什么才能使 VSTS 构建徽章可用于 GitHub 存储库？

在 Java/Maven/Markdown/Git 项目的上下文中 - 如果项目自述文件中的命令行在代码更改后停止工作，那么中断构建的最优雅方法是什么。

我能想到的一个 ant 任务将 grep README.md 中的特定标记，提取代码并执行它。想知道是否有人以更优雅的方式解决了主题问题。

原因是为了防止文档中的示例过时。

我正在寻找一些技巧来在 GITHUB 中自定义我的 README.md。

我不是在谈论大标题，粗体或斜体，但我说的是放置一些形状，闪词或一些颜色。我只是想创建一个有趣的 README.md 以吸引人们关注重要事物。

有办法做到这一点吗？谢谢您的帮助

在我的 GitHubREADME.md文件中，它位于我的 Android 项目的根目录中，我有如下代码片段：

但是，在 Android Studio 中，这些代码片段会出现错误

我不想被警告 README 文件中假定的代码错误。如何在此处禁用所有错误？

笔记：

• 我知道如何在代码中正常抑制检查，@SuppressLint或者进入设置并取消检查 lint 检查。不过，我不希望这些错误在我项目的其他区域中被抑制。
• 有点类似的问题（没有答案）：Android Studio - disable errors highlighting for exclude files

我用部分代码编写了一个 README.md，我想用正确的颜色突出显示这些部分。

其中一个代码是.gitignore 代码，我想将其集成到我的README.md中。但是我不能为此提供良好的语言学家亮点，例如，它会将我的评论涂成绿色。

我搜索了 GFM 检测到的一些语言，但我对结果不满意。

有人可以帮我找到好的语言学家吗？

PS：我还想在 REAMDE 代码高亮中询问 DockerFile，docker-compose。

谢谢， MushuLeDragon

npm 的开发人员文档将 README 和 CHANGELOG 描述为具有变体，但没有描述它们可能是什么。

自述文件（及其变体）

变更日志（及其变体）

是否有一套标准的变体？如果是这样，这些标准将在哪里发布？

我使用该文件记录我的软件，该README.org文件在 GitHub 的 master 分支中很好地呈现。现在，假设我创建了一个标签v1.0并希望与其他人共享一个指向该标签版本的链接。不幸的是，当一个人点击那个链接时，他没有找到我README.org的渲染得很好，而只有存档的代码。那么，在 GitHub 上记录标记版本的正确方法是什么？（当然，我希望重新使用我的README.org）。

我的 GitHub 项目有问题。我正在尝试通过 trustworthy.netlify.com 使其在线，但出现页面构建错误：

您的站点在构建时遇到问题：functions/node_modules/balanced-match/README.md 中第 50 行的变量 {{a} 未使用 }} 正确关闭。有关更多信息，请参阅https://help.github.com/articles/page-build-failed-tag-not-properly-terminated/。

我认为我可以在 {a} 之后添加“}}”，但这是它所指的代码行：

我对 Markdown 语言或 GitHub 的了解不够多，不知道在哪里添加“}}”，或者即使我应该添加，我也不想意外地给我的网站造成巨大的问题。我该怎么办？