reStructuredText工具支持

我是reStructuredText的忠实粉丝,但支持它的工具遍布整个互联网。 官方工具列表不完整和/或过时,只能通过提交权限更新。 一段时间以来,在维基百科reStructuredText页面有一个全面的列表,但这显然“ 没有达到网页内容的知名度指南 ”, 并被删除 。

所以把它放在一个问题的forms: 当使用reStructuredText,例如文本编辑器,Wiki软件,reStructuredText等等的转换器,可以find什么样的工具支持?

从旧版维基百科页面中捞取(并扩展)列表:

文档

  • 底漆
  • 备忘单
  • 快速参考

实现

尽pipereStructuredText的参考实现是用Python编写的,但其他语言也有reStructuredTextparsing器。

Python – Docutils

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

  • rst2html – 从reStructuredText到HTML
  • rst2xml – 从reStructuredText到XML
  • rst2latex – 从reStructuredText到LaTeX
  • rst2odt – 从reStructuredText到ODF文本 (文字处理器)文件。
  • rst2s5 – 从reStructuredText到S5 ,一个简单的基于标准的幻灯片放映系统
  • rst2man – 从reStructuredText到手册

哈斯克尔 – 潘多克

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在线工具 (POT)来试用这个库。 不幸的是,与reStructuredText在线渲染器 (ROR)相比,

  • POT截短input,而不是很短。 POT用户必须以可以由ROR完整呈现的块来呈现input。
  • POT输出缺less由ROR显示的有用错误消息(由docutils生成)

Java – JRst

JRst是一个Java reStructuredTextparsing器。 它目前可以输出HTML,XHTML,DocBook xdoc和PDF,但似乎有严重的问题:PDF或(X)HTML生成工作使用当前完全下载,(X)HTML中的结果页是空的,PDF生成IO问题与XSL文件(不捆绑??)。

斯卡拉 – 莱卡

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

Perl的

  • Text :: Restructured – reStructuredTextparsing器的Perl实现
  • Dotiac :: DTL :: Addon :: markup – 使用通用标记语言的filter – 支持reStructuredText
  • Pod :: POM :: View :: Restructured – 用于输出reStructuredText的Pod :: POM的视图

PHP

  • Gregwar / RST – 一个成熟的PHP5.3parsing器,包含testing
  • php-restructuredtext – 一个简单的,不完整的(但function)的实现

稔/ C

Nim编译器具有将reStructuredText文件转换为HTML和TeX文件的命令 rst2htmlrst2tex 。 标准库提供了以下模块(由编译器使用)以编程方式处理reStructuredText文件:

  • rst – 实现一个reStructuredTextparsing器
  • rstast – 为reStructuredTextparsing器实现AST
  • rstgen – 从reStructuredText实现HTML / Latex的生成器

其他第三方转换器

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

来自reStructuredText

  • restview – 这个pip安装的python包需要docutils ,它做实际的渲染。 restview的主要易用function是,当您保存对文档的更改时,它会自动重新呈现并重新显示它们。 restview
    1. 启动一个小型web服务器
    2. 调用docutils将您的文档呈现为HTML
    3. 调用您的设备的浏览器来显示输出的HTML。
  • rst2pdf – 从reStructuredText到PDF
  • rst2odp – 从reStructuredText到ODF演示
  • rst2beamer – 从reStructuredText到LaTeX Beamer展示类
  • Wikir – 从reStructuredText到Google(也可能是其他)Wiki格式
  • rst2qhc – 将reStructuredText文件集合转换为Qt(工具包)帮助文件和(可选)Qt帮助项目文件

重新构build文本

  • xml2rst是将Docutils内部XML表示(后面)转换为reStructuredText的XSLT脚本
  • Pandoc(见上)也可以从Markdown,HTML和LaTeX转换为reStructuredText
  • db2rst是一个简单和有限的DocBook到reStructuredText翻译器
  • pod2rst – 将.pod文件转换为reStructuredText文件

扩展

一些项目使用reStructuredText作为基础来构build,或者提供额外的function来扩展reStructuredText工具的效用。

狮身人面像

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

rest2web

rest2web是一个简单的工具,可以让你从一个单一的模板(或任意多)build立你的网站,并保持内容reStructuredText。

Pygments来做

Pygments是一个通用的语法高亮显示器,可用于各种软件,如论坛系统,Wiki或其他需要对源代码进行优化的应用程序。 请参阅在reStructuredText文档中使用Pygments 。

免费编辑

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

Emacs的

通过rst模式的Emacs支持作为/docutils/tools/editors/emacs/rst.el下的Docutils包的/docutils/tools/editors/emacs/rst.el

VIM

大多数GNU / Linux发行版都附带了vim-common软件包,它们提供了reStructuredText语法突出显示和开箱即用的reStructuredText缩进支持:

  • vim的reStructuredText语法高亮模式
  • VST(Vim reStructured Text)是Vim7的一个插件,可以折叠reStructuredText
  • Riv.vim – 用于创作rst和Sphinx文档的新鲜vim插件

杰德

Jed程序员编辑器有第一种模式 。

gedit中

gedit,GNOME桌面环境的官方文本编辑器。 有一个gedit reStructuredText插件 。

Geany

Geany是一个小巧轻便的集成开发环境,它包含了对0.12版本 (2007年10月10日)的reStructuredText的支持。

狮子座

Leo是程序员的一个大纲编辑者,通过rst-plugin或者通过“@ auto-first”节点来支持reStructuredText(它没有很好的logging,但是@自动首节点允许直接编辑第一个文件,把结构parsing成Leo大纲) 。

它还提供了一种在“viewrendered”窗格中预览生成的HTML的方法。

FTE

FTE折叠文本编辑器 – 为开发者提供免费(在GNU GPL下授权)的文本编辑器。 FTE 有一个reStructuredText支持模式 。 它提供了基本RSTX元素的颜色突出显示和特殊的菜单,提供了将最stream行的RSTX元素插入文档的简单方法。

PYK

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

带有ReST Editor插件的Eclipse IDE支持编辑reStructuredText文件。

NoTex

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

记事本+ +

Notepad ++是Windows的通用文本编辑器。 它为内置的许多语言提供语法高亮显示,并通过reStructuredText的用户定义语言支持reStructuredText 。

Visual Studio代码

Visual Studio Code是Windows / macOS / Linux的通用文本编辑器。 它为内置的许多语言提供语法高亮显示,并通过LeXtudio 的扩展支持reStructuredText。

专门的reStructuredText编辑器

  • 由Dinu Gherman和Bill Bumgarner重新devise
  • 安息
  • Enthought Tool Suite编辑
  • 重新编写一个像标记一样工作的跨平台程序。
  • RSTPad一个独立的跨平台编辑器,带有实时预览

专有编辑

崇高的文本

Sublime Text是一个完全可定制的,可扩展的源代码编辑器,可用于Windows,OS X和Linux。 长期使用需要注册,但所有function都可以在未注册版本中使用,偶尔会有提醒购买许可证。 版本2和3 (目前处于testing阶段)默认支持reStructuredText语法突出显示,并且可以通过包pipe理器Package Control提供几个插件来提供片段和代码完成,附加语法高亮显示,从RST和其他格式转换到/从HTML预览在浏览器中。

BBEdit / TextWrangler

Mac的BBEdit (及其免费的变体TextWrangler )可以使用这个无代码语言模块来语法高亮显示reStructuredText。

TextMate的

用于Mac OS X的专有通用GUI文本编辑器TextMate具有用于reStructuredText的包 。

input法菜单

Intype是Windows的专有文本编辑器,支持开箱即用的reStructuredText。

E文本编辑器

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

PyCharm

PyCharm (以及其他IntelliJ平台IDE)具有ReST / Sphinx支持(语法高亮和一些自动完成function)。

维基

下面是一些支持reStructuredText标记作为本地标记语法的Wiki程序,或者作为附加组件:

链接到MediaWiki

MediaWiki reStructuredText扩展允许在MediaWiki中由<rst></rst>包围的reStructuredText标记。

MoinMoin的

MoinMoin是一个先进的,易于使用和可扩展的WikiEngine与大量的用户社区。 简而言之,就是在易于编辑的网页上进行协作。

MoinMoin有一个reStructuredTextparsing器 。

TRAC

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

这个维基

这个Wiki是由Ian Bicking编写的Python维基的一个networking软件。 这个wiki使用ReStructuredText作为标记。

rstiki

rstiki是一个极简主义的单文档个人wiki,使用由pwyky启发的reStructuredText语法(通过docutils)。 它不支持作者指示,版本控制,层次结构,镀铬/框架/模板或造型。 它利用docutils / reStructuredText作为wiki语法。 因此,它是在200行代码,并在一个单一的文件。 你把它放在一个目录中,然后运行。

ikiwiki

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

网页服务

砂箱

一个在线reStructuredText编辑器可以用来播放标记,并立即看到结果。

博客框架

WordPress的

WordPreSt reStructuredText插件的WordPress。

电子杂志

Zine的 reStructuredTextparsing器插件 (当Zine计划获得本机reStructuredText支持时,将在0.2版本中过时)

Pelican是一个静态博客生成器,支持在ReST中撰写文章。

海德

Hyde是一个支持ReST的静态网站生成器。

丙烯酰胺

Acrylamid是一个静态博客生成器,支持在ReST中撰写文章。

尼古拉

Nikola是支持ReST的静态网站和博客生成器。

ipsum属

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

Yozuch

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

更多

  • Voidspace:ReStructuredText工具博客文章。
  • 将reStructuredText wiki文章发送到text.docutils.user邮件列表。
  • IBM的Developer Works XML Matters :reStructuredText文章。
  • MZlinux»Marc链接和提示»networking»万维网»Wiki» 结构化文本格式化程序