reStructuredText

reStructuredText是一个易于阅读的，看到的是什么您可以得到的纯文本标记语法和解析器系统。

它对于内联程序文档（例如Python docstrings），快速创建简单的网页以及独立文档很有用。

reStructuredText设计用于特定应用程序域的可扩展性。

reStructuredText解析器是Docutils的组件。

reStructuredText是对StructuredText和Setext轻量级标记系统的修订和重新解释。

reStructuredText的主要目标是定义和实现用于Python docstrings和其他文档领域的标记语法，该语法易读且简单，但足够强大，可以轻松使用。

标记的预期目的是将reStructuredText文档转换为有用的结构化数据格式。

有关使用reStructuredText完整记录的Python模块的示例，请参见statemachine.py。

在线体验

http://rst.ninjs.org/

格式转换

需求

有个说明文档是readme.rst但前端只有markdown解释器，想转换成md格式。

实现

使用pandoc工具进行转换

代码：

sudo apt install pandoc
pandoc readme.rst -f rst -t markdown -o readme.md

在线转换工具

https://zhuanhuan.supfree.net/hao.asp?f=rst&t=md

https://cloudconvert.com/rst-to-md

开源项目

pegdown-rst-serializer

JRst

拓展阅读

参考资料

rst-doc

将rst转换为markdown格式

restructuredtext-tool-support