reStructuredText 工具支持

Question

这个问题的答案是 community effort 。编辑现有答案以改进这篇文章。它目前不接受新的答案或互动。








我是 reStructuredText 的忠实粉丝，但是支持它的工具散落在互联网上。 official tool list 不完整和/或过时，只能通过提交权限更新。一段时间以来，在 Wikipedia reStructuredText page 处有一个综合列表，但这显然是“did not meet the notability guideline for web content”和 was removed。

因此，以问题形式提出: 使用 reStructuredText 时，人们可以期望找到什么工具支持，例如文本编辑器、Wiki 软件、与 reStructuredText 之间的转换器等？

Answer 1

从 old version of the Wikipedia page 抢救(和扩展)列表:

文档

Primer

Cheat Sheet

Quick Reference

实现

尽管 reStructuredText 的引用实现是用 Python 编写的，但也有其他语言的 reStructuredText 解析器。

Python - Docutils

reStructuredText 的主要分布是 Python Docutils 包。它包含几个转换工具:

rst2html - 从 reStructuredText 到 HTML

rst2xml - 从 reStructuredText 到 XML

rst2latex - 从 reStructuredText 到 LaTeX

rst2odt - 从 reStructuredText 到 ODF Text(文字处理器)文档。

rst2s5 - 从 reStructuredText 到 S5，一个简单的基于标准的幻灯片系统

rst2man - 从 reStructuredText 到手册页

Haskell - Pandoc

Pandoc 是一个 Haskell 库，用于从一种标记格式转换为另一种标记格式，以及使用该库的命令行工具。它可以读取 Markdown 和(子集)reStructuredText、HTML 和 LaTeX，并且可以编写 Markdown、reStructuredText、HTML、LaTeX、ConTeXt、PDF、RTF、DocBook XML、OpenDocument XML、ODT、GNU Texinfo、MediaWiki 标记、groff man页面和 S5 HTML 幻灯片。

有一个 Pandoc online tool (POT) 来尝试这个库。不幸的是，与 reStructuredText online renderer (ROR) 相比，

POT 更短地截断输入。 POT 用户必须以块的形式呈现输入，这些块可以由 ROR 整体呈现。

POT 输出缺少 ROR 显示的有用错误消息(由 docutils 生成)

Java - JRst

JRst 是一个 Java reStructuredText 解析器。它目前可以输出 HTML、XHTML、DocBook xdoc 和 PDF，但似乎有严重的问题:PDF 或 (X)HTML 生成都不能使用当前的完整下载，(X)HTML 中的结果页面为空，并且 IO 上的 PDF 生成失败XSL 文件的问题(未捆绑？？)。请注意， the original JRst 已从网站中删除；找到一个 fork on GitHub 。

斯卡拉 - 莱卡

Laika 是一个新的库，用于将标记语言转换为其他输出格式。目前它支持来自 Markdown 和 reStructuredText 的输入并生成 HTML 输出。该库是用 Scala 编写的，但也应该可以从 Java 中使用。

珀尔

Text::Restructured - reStructuredText 解析器的 Perl 实现

Dotiac::DTL::Addon::markup - 使用常见标记语言的过滤器 - 支持 reStructuredText

Pod::POM::View::Restructured - Pod::POM 的 View ，输出 reStructuredText

PHP

Gregwar/RST - 一个成熟的 PHP5.3 解析器，带有测试

php-restructuredtext - 一个简单、不完整(但功能齐全)的实现

C#/.NET

reStructuredText for ANTLR - 带有测试的基于 C# 的解析器(正在进行中)。它还提供了 reStructuredText extension for Visual Studio Code 背后的语言服务器。

尼姆/C

Nim 编译器 features the commands rst2html 和 rst2tex 将 reStructuredText 文件转换为 HTML 和 TeX 文件。标准库提供以下模块(由编译器使用)以编程方式处理 reStructuredText 文件:

rst - 实现重构文本解析器

rstast - 为 reStructuredText 解析器

实现 AST

rstgen - 从 reStructuredText

实现 HTML/Latex 的生成器

其他第三方转换器

大多数(但不是全部)这些工具都基于 Docutils(见上文)，并提供与主要发行版可能不支持的格式之间的转换。

来自重构文本

restview - 这个 pip -installable python 包需要 docutils ，它进行实际渲染。 restview 的主要易用特性是，当您保存对文档的更改时，它会自动重新呈现并重新显示它们。 restview

启动一个小型网络服务器

调用 docutils 将您的文档呈现为 HTML

调用您设备的浏览器以显示输出 HTML。

rst2pdf - 从重构文本到 PDF

rst2odp - 从重构文本到 ODF 演示

rst2beamer - 从 reStructuredText 到 LaTeX beamer 演示类

Wikir - 从 reStructuredText 到 Google(可能还有其他)Wiki 格式

rst2qhc - 将 reStructuredText 文件集合转换为 Qt(工具包)帮助文件和(可选)Qt 帮助项目文件

重构文本

xml2rst 是一个 XSLT 脚本，用于将 Docutils 内部 XML 表示(返回)转换为 reStructuredText

Pandoc(见上文)也可以从 Markdown、HTML 和 LaTeX 转换为 reStructuredText

db2rst 是一个简单而有限的 DocBook to reStructuredText 翻译器

pod2rst - 将 .pod 文件转换为 reStructuredText 文件

扩展

一些项目使用 reStructuredText 作为基线来构建，或提供扩展 reStructuredText 工具效用的额外功能。

狮身人面像

Sphinx 文档生成器将一组 reStructuredText 源文件转换为各种输出格式，自动生成交叉引用、索引等。

休息网

rest2web 是一个简单的工具，可让您从单个模板(或任意多个)构建网站，并将内容保存在 reStructuredText 中。

色素

Pygments 是一种通用语法高亮器，适用于各种软件，例如论坛系统、Wiki 或其他需要美化源代码的应用程序。见 Using Pygments in reStructuredText documents 。

免费编辑

虽然任何纯文本 editor 都适合编写 reStructuredText 文档，但某些编辑器比其他编辑器具有更好的支持。

Emacs

通过 rst-mode 的 Emacs support 是 Docutils 包的一部分，位于 /docutils/tools/editors/emacs/rst.el
Vim

大多数 GNU/Linux 发行版附带的 vim-common 包具有 reStructuredText 语法突出显示和 reStructuredText 开箱即用的缩进支持:

reStructuredText syntax highlighting mode for vim

VST (Vim reStructured Text) is a plugin for Vim7 with folding for reStructuredText

Riv.vim - fresh vim plugin for authoring rst and Sphinx doc

Previm:用于实时预览 reStructuredText 和其他标记文档的 Vim 插件

杰德

rst mode 程序员编辑器有一个 Jed。

编辑

gedit，GNOME 桌面环境的官方文本编辑器。有一个 gedit reStructuredText plugin 。

吉尼

Geany ，一个小而轻的集成开发环境，包括对来自 version 0.12(2007 年 10 月 10 日)的 reStructuredText 的支持。

狮子座

Leo 是程序员的大纲编辑器，通过 rst-plugin 或“@auto-rst”节点支持 reStructuredText(它没有很好的文档，但 @auto-rst 节点允许直接编辑 rst 文件，将结构解析到 Leo 中)。

它还提供了一种在“ View 渲染” Pane 中预览生成的 HTML 的方法。

全职工作人员

FTE 折叠文本编辑器 - 为开发人员提供的免费(根据 GNU GPL 许可)文​​本编辑器。
FTE has a mode 用于 reStructuredText 支持。它提供基本 RSTX 元素的颜色突出显示和特殊菜单，提供将最流行的 RSTX 元素插入文档的简便方法。

皮克

PyK 是 PyEdit 和 reStInPeace 的继承者，在 Qt4 工具包的帮助下用 Python 编写。

eclipse

带有 ReST Editor plug-in 的 Eclipse IDE 支持编辑 reStructuredText 文件。

无纺布

NoTex 是一个基于浏览器的(通用)文本编辑器，具有集成的项目管理和语法高亮。此外，它还可以使用 rST 编写书籍、报告、文章等，并将它们转换为 LaTex、PDF 或 HTML。 PDF 文件具有很高的出版质量，并通过 Sphinx 和 Texlive LaTex 套件生成。

Notepad++

Notepad++ 是适用于 Windows 的通用文本编辑器。它具有内置多种语言的语法突出显示，并通过 user defined language for reStructuredText 支持 reStructuredText。

视觉工作室代码

Visual Studio Code 是适用于 Windows/macOS/Linux 的通用文本编辑器。它内置了多种语言的语法高亮显示，并通过 an extension 中的 0x2518122213341142 支持 reStructuredText。

专用的重构文本编辑器

LeXtudio by Dinu Gherman 和 ReSTedit

Bill Bumgarner

Rest in Peace

Enthought Tool Suite editor 一个像 Marked 一样工作的跨平台程序。

ReText 具有实时预览功能的独立跨平台编辑器

专有编辑器

崇高的文字

RSTPad 是一个完全可定制和可扩展的源代码编辑器，可用于 Windows、OS X 和 Linux。长期使用需要注册，但所有功能在未注册版本中都可用，偶尔会提示购买许可证。版本 Sublime Text 和 2(目前处于测试阶段)默认支持 reStructuredText 语法高亮显示，并且通过包管理器 3 提供了几个插件，以提供片段和代码完成以及其他 RST 格式的代码段和代码转换，以及其他预览语法和其他预览语法浏览器。

BBEdit/TextWrangler

Mac 的 Package Control(及其免费变体 BBEdit )可以使用此 TextWrangler 语法突出显示 reStructuredText 。

文字伴侣

codeless language module 是 Mac OS X 的专有通用 GUI 文本编辑器，具有 TextMate 。

类型

bundle for reStructuredText 是 Windows 的专有文本编辑器，支持开箱即用的 reStructuredText。

E 文本编辑器

Intype 是根据“开放公司许可证”获得许可的专有文本编辑器。它支持 TextMate 的包，所以它应该像 TextMate 一样支持 reStructuredText。

PyCharm

E(以及其他 IntelliJ 平台 IDE？)具有 ReST/Sphinx 支持(语法高亮、自动完成和预览)。 PyCharm )

维基

以下是一些支持 reStructuredText 标记作为 native 标记语法或附加组件的 Wiki 程序:

媒体维基

允许在 MediaWiki reStructuredText extension 中的 reStructuredText 标记被 <rst> 和 </rst> 包围。

货币对

MoinMoin 是一个先进、易于使用和可扩展的 WikiEngine，拥有庞大的用户社区。简而言之，它是关于在易于编辑的网页上进行协作。

有一个 MediaWiki 。

跟踪

Trac 是用于软件开发项目的增强型 wiki 和问题跟踪系统。
有一个 reStructuredText Parser for MoinMoin 。

这个维基

reStructuredText Support in Trac 是 Ian Bicking 为 Python Wiki 编写的 Webware。本维基使用 ReStructuredText 作为其标记。

斯提基

This Wiki 是一个极简主义的单文件个人维基，它使用 reStructuredText 语法(通过 docutils)，灵感来自 rstiki 。它不支持作者指示、版本控制、层次结构、 Chrome /框架/模板或样式。它利用 docutils/reStructuredText 作为 wiki 语法。因此，它不到 200 行代码，并且在一个文件中。你把它放在一个目录中，它就会运行。

维基百科

pwyky 是一个维基编译器。它将 wiki 页面转换为适合在网站上发布的 HTML 页面。 Ikiwiki 将页面和历史存储在版本控制系统中，例如 Subversion 或 Git。还有许多其他功能，包括对博客的支持以及大量插件。它是 Ikiwiki ，但是有些限制，目前不推荐作为其主要标记语言。

网页服务

沙盒

reStructuredText plugin 可用于处理标记并立即查看结果。

博客框架

WordPress

Online reStructuredText editor 用于 WordPress。 (PHP)

杂志

WordPreSt reStructuredText plugin 表示 reStructuredText parser plugin(当 Zine 计划获得 native reStructuredText 支持时，将在 0.2 版中过时)。 Zine 停产了。 (Python)

鹈

Zine 是一个静态博客生成器，支持在 ReST 中写文章。 (Python)

海德

Pelican 是一个支持 ReST 的静态网站生成器。 (Python)

丙烯酰胺

Hyde 是一个静态博客生成器，支持在 ReST 中写文章。 (Python)

尼古拉

Acrylamid 是一个支持 ReST 的静态站点和博客生成器。 (Python)

ipsum属

Nikola 是一个用 Nim 编写的静态博客生成器。

约祖奇

Ipsum genera 是一个用 Python 编写的静态博客生成器。

更多的

Yozuch 博客文章。

Voidspace: ReStructuredText Tools 到 text.docutils.user 邮件列表。

IBM 的开发者作品 reStructuredText wiki post:reStructuredText 文章。

MZlinux » Marc 链接和提示 » 网络 » 万维网 » 维基 » XML Matters