问题标签 [readme]

我在项目的 README.md 文件中遇到了一个非常奇怪的行为。我有 3 个项目的编号列表，当作为原始文件查看时，一切看起来都很好。但是，以降价形式查看时，第二个项目的数字是 1. 而不是 2。

任何帮助，将不胜感激。

这里是项目

我想调和 RDD 和 Breaking.Feature.Fix 版本控制。

这是我的主要问题，我将在 NPM 上发布我的 README，但我不知道如何在没有实际代码的情况下对软件进行版本控制。自述文件将经历许多更改，它必须以某种方式反映在版本中。

以下是我面临的问题：

• 自述文件中记录的 API 的重大更改是否会被视为重大更改？请记住，此时没有代码。
• 第一次 README 提交的版本应该是什么？什么是约定？
• 我应该在第一次代码提交时碰到哪个部分（主要、次要或补丁）？同样，在那之前我只有一个自述文件。
• 在第一次提交代码之前，我应该为我的 README 版本使用预发布标签吗？

我最近一直在写一些 README markdown，我想知道一些开源项目README.md文件是如何使用自动目录呈现的？SystemJS例如，如果您查看他们的README.md文件加载目录，但他们的降价源不包含该目录。

https://github.com/systemjs/systemjs

它必须来自某个地方......见下面的截图：

我正在尝试让我的TeamCity构建服务器的测试结果在GitHub存储库的README.md文件中显示为徽章。我能够让构建状态徽章显示并按需要工作，但我找不到任何适用于测试结果的示例。这可能吗，如果可以，有人可以帮助我吗？

Github中有没有办法在例如 README.md 中包含 md 文件？

它不应该链接到文件，它应该从中加载内容，例如 PHP 包含/file_get_contents。

我可以以某种方式将文件包含到 mkdocs 中的文件中吗？我不想一次又一次地复制粘贴相同的部分。谢谢

我正在使用 angularJs 中的一个应用程序，它显示readme.md来自 github 的文件并动态生成自述文件我应该使用什么 api 从 GitHub 访问 readme.md 并创建一个包含图像的自述文件。

我已经为我正在研究的程序获得了许可证。

我的问题是：是否可以在 github 目录中显示文件（在我的情况下license.md：） ？readme.md

我使用了以下控制器，但是如何将 README.MD 原始文件的每一行格式化为 html 文档

我很高兴知道将原始自述文件转换为格式化的 html 页面

如果可能的话，我想自动将 WordPress 插件列表附加到现有的 README 文件（最好是 markdown）。我一直在摆弄这个想法，但到目前为止，我只能使用 gulp-filelist 将给定目录中的文件名通过管道传输到 JSON 格式的新文件中。也许这是一个开始。

需要明确的是，所需的解决方案可能是可以间歇运行的命令行工具；如果这样的事情太令人头疼（或不可能），则无需实时更新。此外，虽然查看活动WP 插件和版本号列表会非常好，但仅列出所有已安装插件的列表就足够了。