github - 在“github pages”站点中查看 .rst

Question

我正在将一个开源项目的文档移至 Github Pages，但我一直在移动 .rst 文件。

我们有一个 ReadMe.rst，您可以在此处的代码中看到它。我想从我们的主文档页面链接到该页面，但 GitHub 不会将 .rst 呈现为 HTML，因此当您单击链接时浏览器只会下载 .rst 文件的文本）。

当然有工具可以将 .rst 呈现为 HTML，但这是一个重要的额外步骤。我们开始使用 .rst 的全部原因完全是因为 GitHub 会在代码页中自动呈现它。你会认为有一些方法可以让 Github Pages 发生这种自动渲染......

score 5 · Accepted Answer

5

GitHub Pages 不支持 .rst/RestructuredText。它只支持 Markdown 和 Textile 转换为 HTML。

于 2014-08-03T20:00:52.313 回答

score 0 · Accepted Answer

GitHub Pages 不直接支持 reStructuredText，但 Anne Gentle 创建了一个很好的演示，说明如何通过相当简单的步骤获得一些东西：

查看 github 工作流程，了解如何在每次提交时从 reStructuredText 源自动生成所需的 HTML 尤其有用。

2 回答 2