在“github pages”网站中查看.rst

Question

我正在将一个开源项目的文档移到Github Pages上，但我仍然坚持移动.rst文件。

我们有一个ReadMe.rst，您可以在代码中看到here。我想从main documentation page链接到该页面，但GitHub不会将.rst呈现为HTML，因此当您单击the link时，浏览器只会下载.rst文件的文本。 / p>

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

Answer 1

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

Answer 2

GitHub Pages 不直接支持 reStructuredText，但 Anne Gentle 已经创建了一个很好的演示，展示了如何通过相当简单的步骤获得工作：

https://github.com/annegentle/create-demo

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