tutorial rst online restructuredtext

restructuredtext - online - rst file



Soporte de herramienta reStructuredText (1)

Salvando (y extendiendo) la lista de una versión anterior de la página de Wikipedia :

Documentación

Implementaciones

Aunque la implementación de referencia de reStructuredText está escrita en Python, también hay analizadores reStructuredText en otros idiomas.

Python - Docutils

La distribución principal de reStructuredText es el paquete Python Docutils . Contiene varias herramientas de conversión:

  • rst2html - de reStructuredText a HTML
  • rst2xml - de reStructuredText a XML
  • rst2latex - de reStructuredText a LaTeX
  • rst2odt: del documento reStructuredText al texto ODF (procesador de textos).
  • rst2s5 - de reStructuredText a S5 , un sistema de presentación de diapositivas basado en estándares simples
  • rst2man - de la página reStructuredText a Man

Haskell - Pandoc

Pandoc es una biblioteca Haskell para convertir de un formato de marcado a otro, y una herramienta de línea de comandos que usa esta biblioteca. Puede leer Markdown y (subconjuntos de) reStructuredText, HTML y LaTeX, y puede escribir Markdown, reStructuredText, HTML, LaTeX, ConTeXt, PDF, RTF, DocBook XML, OpenDocument XML, ODT, GNU Texinfo, marcado MediaWiki, groff man páginas, y S5 HTML muestra diapositivas.

Hay una herramienta en línea de Pandoc (POT) para probar esta biblioteca. Desafortunadamente, en comparación con el renderizador en línea reStructuredText (ROR),

  • POT trunca la entrada bastante más brevemente. El usuario de POT debe presentar la información en fragmentos que el ROR podría restituir.
  • La salida POT carece de los mensajes de error útiles mostrados por el ROR (y generados por docutils )

Java - JRst

JRst es un analizador de texto reStructuredText de Java. Actualmente puede generar HTML, XHTML, DocBook xdoc y PDF, PERO parece tener serios problemas: ni PDF ni (X) la generación de HTML funciona con la descarga completa actual, las páginas de resultados en (X) HTML están vacías y la generación de PDF falla en IO problemas con los archivos XSL (no incluido?).

Scala - Laika

Laika es una nueva biblioteca para transformar los lenguajes de marcado a otros formatos de salida. Actualmente admite entrada desde Markdown y reStructuredText y produce salida HTML. La biblioteca está escrita en Scala pero también se puede usar desde Java.

Perl

PHP

C # /. NET

Nim / C

El compilador Nim presenta los comandos rst2html y rst2tex que transforman los archivos reStructuredText en archivos HTML y TeX. La biblioteca estándar proporciona los siguientes módulos (utilizados por el compilador) para manejar los archivos reStructuredText de forma programática:

  • rst : implementa un analizador reStructuredText
  • rstast - implementa un AST para el analizador reStructuredText
  • rstgen : implementa un generador de HTML / Latex de reStructuredText

Otros convertidores de terceros

La mayoría (pero no todas) de estas herramientas se basan en Docutils (ver arriba) y brindan conversión hacia o desde formatos que podrían no ser compatibles con la distribución principal.

De reStructuredText

  • restview - Este paquete python restview pip requiere docutils , que hace la representación real. La principal función de facilidad de uso de restview es que, cuando guarda cambios en su (s) documento (s), automáticamente los vuelve a renderizar y los vuelve a mostrar. restview
    1. inicia un pequeño servidor web
    2. llama a docutils para renderizar sus documentos a HTML
    3. llama al navegador de su dispositivo para mostrar el HTML de salida.
  • rst2pdf - de reStructuredText a PDF
  • rst2odp - de reStructuredText a ODF Presentation
  • rst2beamer - de reStructuredText a LaTeX beamer Clase de presentación
  • Wikir : de los Wikir a Google (y posiblemente a otros) Wiki
  • rst2qhc - Convierta una colección de archivos reStructuredText en un archivo de Ayuda Qt (toolkit) y (opcional) un archivo Qt Help Project

Para reStructuredText

  • xml2rst es una secuencia de comandos XSLT para convertir la representación XML interna de Docutils (volver) a reStructuredText
  • Pandoc (ver arriba) también puede convertir de Markdown, HTML y LaTeX a reStructuredText
  • db2rst es un traductor de DocBook a db2rst simple y limitado
  • pod2rst - convierte archivos .pod a archivos reStructuredText

Extensiones

Algunos proyectos usan reStructuredText como línea de base para construir, o proporcionan una funcionalidad adicional que extiende la utilidad de las herramientas reStructuredText.

Esfinge

El generador de documentación Sphinx traduce un conjunto de archivos fuente reStructuredText en varios formatos de salida, produciendo referencias cruzadas, índices, etc.

rest2web

rest2web es una herramienta simple que le permite crear su sitio web desde una sola plantilla (o tantas como desee), y mantener los contenidos en reStructuredText.

Pygments

Pygments es un resaltador de sintaxis genérico para uso general en todo tipo de software, como sistemas de foros, wikis u otras aplicaciones que necesitan embellecer el código fuente. Consulte Uso de Pygments en documentos reStructuredText .

Editores gratis

Si bien cualquier editor texto plano es adecuado para escribir documentos reStructuredText, algunos editores tienen mejor soporte que otros.

Emacs

El soporte de Emacs a través del primer modo viene como parte del paquete /docutils/tools/editors/emacs/rst.el en /docutils/tools/editors/emacs/rst.el

Empuje

El paquete vim-common para eso viene con la mayoría de las distribuciones de GNU / Linux, tiene sintaxis reStructuredText resaltado y soporte de sangría de reStructuredText de fábrica:

Jed

Hay un primer modo para el editor de programadores Jed .

gedit

gedit, el editor de texto oficial del entorno de escritorio GNOME. Hay un plugin gedit reStructuredText .

Geany

Geany , un entorno de desarrollo integrado pequeño y liviano, incluye soporte para reStructuredText a partir de la versión 0.12 (10 de octubre de 2007).

León

Leo , un editor de programación para programadores, admite reStructuredText a través de rst-plugin o mediante nodos "@ auto-rst" (no está bien documentado, pero los nodos @ first-rst permiten editar primeros archivos directamente, analizando la estructura en el esquema de Leo) .

También proporciona una forma de obtener una vista previa del HTML resultante, en un panel "visualizado".

FTE

El editor de texto FTE plegable: un editor de texto gratuito (con licencia de GNU GPL) para desarrolladores. FTE has un mode para el apoyo de ReStructuredText. Proporciona resaltado en color de los elementos RSTX básicos y un menú especial que proporcionan una manera fácil de insertar los elementos RSTX más populares en un documento.

PyK

PyK es un sucesor de PyEdit y reStInPeace, escrito en Python con la ayuda del kit de herramientas Qt4.

Eclipse

El IDE de Eclipse con el plugin ReST Editor proporciona soporte para editar archivos reStructuredText.

NoTex

NoTex es un editor de texto basado en navegador (de propósito general), con administración integrada de proyectos y resaltado de sintaxis. Además, permite escribir libros, informes, artículos, etc. utilizando rST y convertirlos a LaTex, PDF o HTML. Los archivos PDF son de alta calidad de publicación y se producen a través de Sphinx con el paquete Texlive LaTex.

Notepad ++

Notepad++ es un editor de texto de propósito general para Windows. Tiene resaltado de sintaxis para muchos idiomas incorporados y soporte para reStructuredText a través de un lenguaje definido por el usuario para reStructuredText .

Código de Visual Studio

Visual Studio Code es un editor de texto de propósito general para Windows / macOS / Linux. Tiene resaltado de sintaxis para muchos idiomas incorporados y admite reStructuredText a través de una extensión de LeXtudio .

Editores dedicados de ReStructuredText

Editores propietarios

Texto sublime

Sublime Text es un editor de código fuente completamente personalizable y extensible disponible para Windows, OS X y Linux. El registro es necesario para el uso a largo plazo, pero todas las funciones están disponibles en la versión no registrada, con recordatorios ocasionales para comprar una licencia. Las versiones 2 y 3 (actualmente en beta) admiten el resaltado de sintaxis reStructuredText por defecto, y varios complementos están disponibles a través del Package Package Manager para proporcionar fragmentos y finalización de código, resaltado de sintaxis adicional, conversión a / desde RST y otros formatos, y vista previa HTML en el navegador.

BBEdit / TextWrangler

BBEdit (y su variante gratuita TextWrangler ) para Mac puede resaltar la sintaxis reStructuredText usando este módulo de lenguaje sin código .

TextMate

TextMate , un editor de texto GUI de uso general patentado para Mac OS X, tiene un paquete para reStructuredText .

En tipo

Intype es un editor de texto propietario para Windows, que admite reStructuredText Intype .

E Editor de texto

E es un editor de texto propietario bajo la licencia "Open Company License". Es compatible con los paquetes de TextMate, por lo que debería ser compatible con reStructuredText de la misma manera que lo hace TextMate.

PyCharm

PyCharm (y otros IDE de plataforma IntelliJ?) Tiene soporte para ReST / Sphinx (resaltado de sintaxis y algunas características de autocompletar).

Wiki

Aquí hay algunos programas de Wiki que admiten el marcado reStructuredText como la sintaxis de marcación nativa, o como un complemento:

MediaWiki

La extensión MediaWiki reStructuredText permite el marcado reStructuredText en MediaWiki rodeado por <rst> y </rst> .

MoinMoin

MoinMoin es un WikiEngine avanzado, fácil de usar y extensible con una gran comunidad de usuarios. Dicho en pocas palabras, se trata de la colaboración en páginas web fácilmente editables.

Hay un analizador reStructuredText para MoinMoin .

Trac

Trac es un wiki mejorado y un sistema de seguimiento de problemas para proyectos de desarrollo de software. Hay un Soporte de Restructurado de Texto en Trac .

Esta Wiki

Esta Wiki es un Webware para Python Wiki escrito por Ian Bicking. Esta wiki usa ReStructuredText para su marcado.

rstiki

rstiki es una wiki personal minimalista de un solo archivo que utiliza la sintaxis reStructuredText (a través de docutils) inspirada en pwyky . No es compatible con la indicación de autoría, control de versiones, jerarquía, chrome / framing / plantilla o estilo. Aprovecha docutils / reStructuredText como la sintaxis wiki. Como tal, tiene menos de 200 líneas de código y en un solo archivo. Lo pones en un directorio y se ejecuta.

ikiwiki

Ikiwiki es un compilador de wiki. Convierte páginas wiki en páginas HTML adecuadas para publicar en un sitio web. Ikiwiki almacena páginas e historial en un sistema de control de revisiones como Subversion o Git. Hay muchas otras características, como soporte para blogging, así como una gran variedad de complementos. Es un complemento reStructuredText , sin embargo, es algo limitado y no se recomienda como su principal lenguaje de marcado en este momento.

Servicios web

Salvadera

Se puede utilizar un editor de texto reStructuredText para jugar con el marcado y ver los resultados de inmediato.

Marcos de blogs

WordPress

WordPreSt reStructuredText plugin para WordPress.

Zine

ReStructuredText parser plugin for Zine (Se volverá obsoleto en la versión 0.2 cuando Zine esté programado para obtener un soporte nativo reStructuredText)

pelícano

Pelican es un generador de blogs estático que admite la redacción de artículos en ReST.

Hyde

Hyde es un generador de sitios web estáticos que admite ReST.

Acrilamida

Acrylamid es un generador de blogs estático que admite la redacción de artículos en ReST.

Nikola

Acrylamid es un generador de sitios y blogs estáticos que admite ReST.

géneros ipsum

Ipsum genera es un generador de blogs estático escrito en Nim.

Yozuch

Yozuch es un generador de blogs estático escrito en Python.

Más

Soy un gran admirador de reStructuredText , sin embargo, las herramientas que lo soportan están diseminadas por todo Internet. La lista de herramientas oficial está incompleta y / o desactualizada, y solo se puede actualizar mediante privilegios de confirmación. Durante algún tiempo hubo una lista completa en la página de texto reStructuredText de Wikipedia , pero aparentemente " no cumplía con la pauta de notabilidad para el contenido web " y se eliminó .

Entonces, para ponerlo en forma de pregunta: ¿Qué soporte de herramientas se puede esperar al trabajar con reStructuredText, por ejemplo, editores de texto, software Wiki, convertidores desde y hacia reStructuredText, etc.?