小编典典

在Markdown和reStructuredText中都具有相同的自述文件

python

我有一个托管在GitHub上的项目。为此,我使用Markdown语法编写了自述文件,以便在GitHub上很好地格式化它。

由于我的项目是使用Python,因此我还计划将其上传到PyPi。PyPi上用于README的语法为reStructuredText。

我希望避免处理两个包含大致相同内容的自述文件;因此,我搜索了RST(或相反)转换器的降价标签,但找不到任何内容。

我看到的另一个解决方案是执行markdown / HTML,然后执行HTML /
RST转换。我在这里这里都找到了一些资源,所以我猜应该是可行的。

您有什么想法更适合我的工作吗?


阅读 192

收藏
2021-01-20

共1个答案

小编典典

我会推荐Pandoc,“将文件从一种标记格式转换为另一种格式的瑞士军刀”(请查看页面底部的受支持的转换图,这非常令人印象深刻)。Pandoc允许markdown直接进行reStructuredText翻译。此外,还有一个在线编辑器,在这里它可以让你尝试一下,所以你可以简单地使用在线编辑器来转换你的自述文件。

2021-01-20