问题标签 [readme]

README.md我的项目underscore-cli有一个文件，我想记录该--color标志。

目前，唯一的方法是使用屏幕截图（可以存储在项目存储库中）：

但截图不是文本，防止读者在截图中复制/粘贴命令。它们的创建/编辑/维护也很痛苦，并且浏览器加载速度较慢。现代网络使用文本样式，而不是一堆渲染的文本图像。

虽然一些 Markdown 解析器支持内联 HTML 样式，但 GitHub 不支持；这不起作用：

这不起作用：

最近我加入了GitHub。我在那里主持了一些项目。

我需要在我的自述文件中包含一些图像。我不知道该怎么做。

我对此进行了搜索，但我得到的只是一些链接，这些链接告诉我“在网络上托管图像并在 README.md 文件中指定图像路径”。

有没有办法在不将图像托管在任何第三方网络托管服务上的情况下做到这一点？

编辑问题并单击预览以下降价源时：

在新行上显示每个字母。

但是，在我看来，在 README.md 中推送类似的降价源结构会将所有字母连接到一行。

我想在这个项目的 README.md 中保留新行：https ://github.com/zoran119/simple-read-only-test

知道怎么做吗？

在我的一个项目中，我使用外部图像链接通过 GitHub 页面显示屏幕截图，该页面会自动解析 README.rst

ROyWeb 的 GitHub 页面

在过去的几周里，我在我的网络服务器上多次更新了这个截图，我只是意识到它没有在 GitHub 页面上更新，因为......我认为它从未更新过 ;-) GitHub 以某种方式下载了图像并从它的缓存服务器。

在 README.rst 中，显然有正确的链接：

ROyWeb 截图的实际链接

当您加载原始文件时，您可以确认：

GitHub 上的原始 README.txt

但是当我检查 GitHub 页面上显示图像的 URL 时，我得到：

ROyWeb 的 GitHub 缓存截图

有谁知道如何强制“重新缓存”？

我知道我可以使用星号来做这样的事情：

• 列表项 1
• 列表项2

但我期待着**进一步缩进它。是否可以？

BitBucket 使用 MarkDown 来呈现带有我们存储库中的 readme.md 文件的“索引页面”。

readme.md 文件中有一个字符串，看起来像一个提交哈希 'a68c7c33f98668bea65636a7462a94f17446e151' 但它不是。

现在显然 bitbucket 使用 urlize（来自 django 的项目）来自动链接我们 readme.md 中有用的所有内容。

这对链接很有用，但当这个不是提交的哈希变成一个不存在的提交的链接时就没有用了。

我现在正在寻找一种简单的方法来取消链接此哈希而不将其标记为源代码。

任何人的想法？

谢谢！

我有一个 Python 包。我添加了一个README.rst文件来显示描述。它在GitHub中正确显示

但是，在PyPI上，我的 RST 文件未格式化；它正在显示原始内容。

您可以在此处setup.py找到该文件。有人可以帮我吗？

我正在尝试创建一个自定义 Xcode 6 项目模板。使用 Single View 项目创建项目时的标准文件布局如下所示：

如何使用自定义 xcode 模板将文件添加到此顶层？我想添加 .gitignore 和 README.md 文件，所以它看起来像这样：

对于 eclipse 中的深色方案，默认的 markdown 颜色很难阅读。例如，这使得编辑 README.md 文件变得困难。

我花了一段时间才找到更改字体颜色的正确设置，并认为我会分享答案。

我在实际发布 npm 包方面的经验非常有限，所以这可能是一个相当业余的问题。我最初的印象是，包的 npmjs.com 页面上的自述文件是通过在我的 package.json 中指定一个"readme"和/或"readmeFilename"字段来填充的。我最近了解到这实际上是完全不正确的，我不应该触及这些领域中的任何一个。

考虑到这一点，我如何控制包裹页面上显示的内容？它是从 README.md 文件中自动提取的吗？如果是这样，如果我更改自述文件并npm publish再次运行，它会自动更新吗？npm 的网站使用什么 Markdown 解析器？