在“GitHub Pages”网站中查看 .rst 文件

Question

9

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

我们有一个ReadMe.rst，你可以在代码中这里看到它。我想从我们的主文档页面链接到那个页面，但是GitHub不会将.rst渲染为HTML，因此当你单击链接时，浏览器只会下载.rst文件的文本。

当然，有工具可以将.rst渲染为HTML，但那是一个严重的额外步骤。我们开始使用.rst的整个原因完全是因为GitHub自动在代码页面中渲染它。你会认为应该有一些方法来使Github Pages自动进行渲染...

- Tom Swirly

你找到什么了吗？我也遇到了同样的问题。 - dmeu

不，很遗憾我们放弃了。 :-( 如果您有任何结果，请在此更新我们。 - Tom Swirly

@TomSwirly 根据你的链接，看起来你已经决定使用sphinx来渲染你的README.rst文件。这正是我为我的一个存储库之一所选择的解决方案。（尚未实现。） - Louis

@Louis-DominiqueDubeau - 是的，它实际上运行得非常好。该项目仍然名义上处于测试版，但实际上已经相当成熟并且有些在使用，所以我猜肯定有人在阅读那份文档... - Tom Swirly

2个回答

0

GitHub Pages并不直接支持reStructuredText，但Anne Gentle创建了一个很好的演示，展示了如何通过相对简单的步骤使其正常工作：

特别有用的是查看 Github 工作流程，了解如何在每次提交时自动生成所需的 HTML 代码从 reStructuredText 源文件中。

- Epcylon

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- parkr · Accepted Answer

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