问题标签 [readme]

更新：这是此问题的GitHub 测试存储库。

我将屏幕截图 ( screenshot.png) 存储在单独的 Git 分支 ( assets) 中，以便在 README.md 文件中使用（在master分支上）。

要查看 GitHub 上的图像，我必须链接到：

或者

但是，这在本地查看README文件时不起作用，图像不显示（例如在VS Code或Atom中使用Markdown预览功能时）。

我什至使用了git worktree功能来检查assets子目录中的assets分支：

所以目录结构是这样的：

这意味着，为了在 README 文件中本地查看图像，我必须链接到

或者

如何调和这两个“世界”？

有没有办法链接到屏幕截图，所以它总是显示，“无论我在 GitHub 本身上查看文档，还是在本地查看文档，使用不同的标记渲染器” *？

我得到了这个项目，我正在与其他合作者合作，该项目分为几个阶段，每个阶段都有它的时间框架。我想创建一个倒数计时器，它应该始终显示在 github 上的 README.md 文件中，这样每当合作者访问 github 存储库时，他/她就会看到完成该阶段的剩余时间。

像这样的东西：

但是我不希望它在第一阶段完成后自动触发下一阶段，我很想成为下一阶段再次触发倒计时的人。

注意：我在问如何在 github 的 README.md 文件中实现这一点

这可能是一个愚蠢的问题，但我不知道如何将彩色关键字标签添加到我的readme.md文件中

在此处查看我所追求的示例 https://github.com/reactstrap/reactstrap

如何获得类似于您可以在上面链接的页面上看到的这些：CDNJS NPM 版本构建状态覆盖状态许可证

使用 GitHub 的基于 Web 的界面，我无法弄清楚如何为项目的 README 文件指定备用路径/文件名。

创建新 README 时，Web 界面确实让我可以选择使用我想要的任意路径或文件名，但我选择的文件不用作项目级 README。我希望在用户访问项目页面时显示它。

在作为模块或扩展的项目（例如 Magento 1 模块）的上下文中，/README.md所有此类项目的所有此类 README 文件都会使它们在最终合并中全部被覆盖，因此应使用备用路径或文件名（例如/docs/projectname/README.md或/projectname.md）。

如何以将该文件指定为默认自述文件的方式执行此操作？

我的 github 自述文件没有以正确的方式呈现。我用这个：

但是渲染这个：

我没有看到上面的答案，所以这是我的问题：

我有一组项目。它们表示为嵌套的 Git 子模块，如下所示：

每个子模块都有一个 README.md 文件和 CHANGELOG.md 文件（标准 GitHub 模型）：

我想要做的是使用“根”自述文件作为转储中的主页，但仍然呈现内部自述文件，因为每个自述文件都有很好的信息。

我不想单独构建每个 Doxygen 转储。我想要一个从“根”开始的单一的、整体的转储。这是因为我想要类和诸如此类的链接。

有没有办法做到这一点？我尝试明确指定“根”自述文件，但看起来您只能提供文件名，而不是路径。这意味着每个 README 都会被考虑用于发布，并且获胜的是“最深”的。

我正在尝试使用 Mermaid 在降价文件中呈现流程图。我的 GitHub 存储库中有一个 ReadMe.md 文件，我想包含一个基本流程图来帮助描述内容。但我不知道如何让它工作。有人可以就如何呈现一个简单的示例发布一些更具体的说明吗？

在此链接 ( https://unpkg.com/mermaid@8.0.0-rc.8/README.md ) 中，有一个美人鱼安装的示例代码片段：

我包含了该代码，然后尝试在下一个代码片段中制作流程图：

但它所做的只是在我预览它时在 Markdown 文件中打印出该文本。

似乎基于美人鱼自述文件是可能的： https ://github.com/knsv/mermaid/blob/master/README.md 。但是当我查看代码时，它实际上是流程图的图片，而不是代码的渲染。所以也许我问的是不可能的？

将不胜感激任何帮助！

如何在 GitHub readme.md中创建链接以在新选项卡中打开链接

[my website](www.google.com)

有时，在 GitLab、GitHub、BitBucket 等托管的项目中，需要以一种以上的语言提供自述文件。在这个项目中，作者创建了一个README.md英文主文件以及其他README-<lang>.md文件。

是否有一套推荐的良好做法？

我正在使用 Gitlab 并尝试包含一个管道 | 签名为 README.md 文件中表内的内容。我按照此处显示的示例进行操作，但输出不是预期的。还有其他方法吗？

自述文件内容

我的输出

预期产出

另外，如何在这样的代码块中使用管道：