在"github pages“站点中查看.rst

Question

我正在将一个开源项目的文档转移到Github Pages上，但是我被困在了移动.rst文件上。

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

当然，有一些工具可以将.rst呈现为超文本标记语言，但这是一个严重的额外步骤。我们开始使用.rst的全部原因完全是因为GitHub在代码页中自动呈现它。你可能会认为有一些方法可以让Github页面实现这种自动渲染……

Answer 1

GitHub页不支持.rst/RestructuredText。它只支持Markdown和Textile到HTML的转换。

Answer 2

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

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

查看github工作流，了解如何在每次提交时自动从reStructuredText源生成所需的超文本标记语言，这一点特别有用。