问题标签 [readme]

背景：

当您登陆GitHub网站上的存储库页面时，它会自动呈现README.md位于根目录中的文件。

问题：

我想为iOSand单独设置一个，Windows并根据查看页面的操作系统显示相应的。这是你能做的吗？

iOS我目前想到的解决方案是只为and部分提供一个带有可点击标签的超大文件Windows，以便用户可以单击并跳转到该部分 - 这并不理想，因为这个文件会变得非常大（它是用作设置指南）。

你如何使用带有HighlightJS标记的 npm ？我正在尝试自动化我的文档以进行解析和样式化。从标记的文档中查看以下示例：

我看不到如何使用README.md文件而不是带有手动转义特殊字符的字符串。使用示例不涉及对.md文档的任何引用作为markdownString.

如何将 markdown 字符串作为文档（例如形成名为 的文件README.md）而不是手动转义的字符串传递，并且最终输出还包括样式？

目标是能够传入 linted（我正在使用 VS 代码markdownlint）README.md、主文档 CSS 和或 highlightJS css，并让最后一行 ( marked(markdownString)) 的返回值成为我可以直接写入.html文件。

另一个注意事项：我的降价文件还在多行代码块中指定语言。例如，我的 README.md 中的多行 JSON 块如下所示：

我负责在我们公司发布的一个库作为 NuGet 包，我按照“添加自述文件和其他文件”指南显示一个 readme.txt，其中包含用户在使用 Visual Studio 时安装或更新包时的重要更改。这有效 - 即当您安装软件包时，会显示 readme.txt。但是，当您安装软件包时，此 readme.txt 文件也将被复制到目标项目的根目录中。

有谁知道我可以如何阻止它（即安装时显示 readme.txt，但不要将其添加到目标项目中）？用户查看此文件非常有用，但如果将其添加到项目中会令人困惑。

库的 .nuspec 如下所示：

打包 + 推送通常由 TeamCity 构建步骤执行，但如果我使用以下命令行构建 pkg，则会出现相同的行为：

背景信息

我有一个由许多构造函数组成的 JS 库。我正在使用grunt-concat&-uglify将它们编译成一个文件。

每个构造函数都有一个readme.md文件。

该库用于创建广告横幅。它被大约 10 名开发人员使用，他们在Templates使用该库的文件夹中创建自己的广告模板。这些文件.xml还提供了一个CDATA标签，可以在其中插入 JavaScript 代码。

问题

我想readme用计数器填充文件，以便开发人员可以直接在其文档中看到特定构造函数的受欢迎程度。

出现次数（<% 出现 %>）

我已经做了什么

我可以通过执行获得出现次数 find . -name "*.xml" -exec grep -e "new\Foo\.Bar" {} \; | wc -l

如果我能抓住这个值并将其插入到readme文件中，那就太好了。

在 GitHub 或 BitBucket 中每个存储库的主页上，它以非常漂亮的格式显示 Readme.md。

有没有办法用红宝石做同样的事情？我已经找到了一些像Redcarpet这样的宝石，但它看起来并不漂亮。我已按照Redcarpet 的说明进行操作。

编辑：在我尝试了Github 的标记 ruby​​ gem之后，同样的事情正在发生。显示的是这样的： 而我想要的是这样的：

而且我确信它不仅缺少 css，因为在 3 个反引号 (```) 之后，我编写了类似jsonor的语法，bash并且在第一张图像中它被写入了。

编辑2：

这段代码在这里：

生成了这个：

我一直在使用shields.io在 README 文件中构建我的 GitHub 徽章，但仅限于许可证和版本等徽章。

现在，我的目标是在特定 repo 的手表数量上构建动态徽章，以便在新人观看 repo 时数字更新。

最好的方法是什么？

我在 Pypi 上发布了我的个人项目：cannondb-pypi 这是我的 github 页面：cannondb-github

README 文件已从 markdown 转换为 rst，并且我确实有一个完全正确的 setup.py 配置。但真正让我困惑的是 Pypi 不能真正显示我的 REAME 信息。

在 PULL_REQUEST_TEMPLATE.md 中按照指示使用相对链接（https://help.github.com/articles/about-readmes/#relative-links-and-image-paths-in-readme-files）不会正确相对链接.

在实际 PR 中查看时：

• 
<code>[CONTRIBUTING.md](/.github/CONTRIBUTING.md)


路线：https://github.com/.github/CONTRIBUTING.md.

• [CONTRIBUTING.md](.github/CONTRIBUTING.md)
• 
<代码>[CONTRIBUTING.md](./.github/CONTRIBUTING.md)

路线： https://github.com/owner/repo/compare/.github/CONTRIBUTING.md

而不是https://github.com/owner/repo/.github/CONTRIBUTING.md.

更改为../上一级对 PR 有效，但在 GitHub UI 中查看时会断开链接。

单击在 GitHub 上查看的链接有效：https ://github.com/fs-webdev/fs-dialog/blob/master/.github/PULL_REQUEST_TEMPLATE.md ，只是不在 PR 中。

（我觉得这曾经在 2017 年工作过）

在这两种情况下，具有预期相对链接功能的正确方法是什么？

假设我想在我的markdown文档中创建以下链接：

• https://github.com/kaushal02/CP/search?q=_QueryString
• https://github.com/kaushal02/CP/search?q=_AnotherQueryString
• https://github.com/kaushal02/CP/search?q=_YetAnotherQueryString

由于所有这些链接都有一个共同的前缀，有没有办法创建一个规则，这样当我传递一个参数时，说QueryString然后它创建一个链接“ https://github.com/kaushal02/CP/search?q= _查询字符串“？

另外，当我们编写一个有效的 http-link 文本时，有没有办法抑制链接创建？

当浏览到https://github.com/timotheecour/D_vs_nim或https://github.com/timotheecour/D_vs_nim/blob/master/README.md我希望显示的降价以自定义（更大）宽度显示. 那可能吗？如果可能，宽度将取决于浏览器窗口大小，例如width=max(browser_width, fixed_width).

编辑：好奇https://github.com/github/markup中的 PR 是否有助于实现这一目标。