web-dev-qa-db-fra.com

Support de l'outil reStructuredText

Je suis un grand fan de reStructuredText , mais les outils qui le supportent sont disséminés sur Internet. Le liste officielle d'outils est incomplet et/ou obsolète et ne peut être mis à jour que via les privilèges de validation. Pendant un certain temps, une liste complète figurait sur la page page de reStructuredText de Wikipedia , mais apparemment " ne respectait pas la règle de notabilité pour le contenu Web " et a été enlevé .

Donc, pour le mettre sous forme de question: Quel outil support on peut s’attendre à trouver lorsqu’on travaille avec reStructuredText, par exemple. éditeurs de texte, logiciel Wiki, convertisseurs vers et à partir de reStructuredText etc.?

restructuredtext
128
Chen Levy

Récupérer (et étendre) la liste d'une ancienne version de la page Wikipedia :

Documentation

Implémentations

Bien que l'implémentation de référence de reStructuredText soit écrite en Python, il existe également des analyseurs syntaxiques reStructuredText dans d'autres langages.

Python - Docutils

La distribution principale de reStructuredText est le package Python Docutils . Il contient plusieurs outils de conversion:

  • rst2html - de reStructuredText à [~ # ~] html [~ # ~]
  • rst2xml - de reStructuredText à [~ # ~] xml [~ # ~]
  • rst2latex - de reStructuredText à LaTeX
  • rst2odt - de reStructuredText à Texte ODF (traitement de texte).
  • rst2s5 - de reStructuredText à S5, un système de diaporama simple basé sur des normes
  • rst2man - de reStructuredText à page de manuel

Haskell - Pandoc

Pandoc est une bibliothèque Haskell pour la conversion d'un format de balisage en un autre, ainsi qu'un outil en ligne de commande qui utilise cette bibliothèque. Il peut lire Markdown et (sous-ensembles de) reStructuredText, HTML et LaTeX, et il peut écrire Markdown, reStructuredText, HTML, LaTeX, ConTeXt, PDF, RTF, DocBook XML, OpenDocument XML, ODT, GNU Texinfo , Balisage MediaWiki, pages de manuel groff et diaporamas HTML S5.

Il existe un outil en ligne Pandoc (POT) pour essayer cette bibliothèque. Malheureusement, comparé au rendu en ligne reStructuredText (ROR),

  • POT tronque l'entrée assez rapidement. L'utilisateur POT doit rendre les entrées en morceaux qui pourraient être rendus entiers par le ROR.
  • La sortie POT ne contient pas les messages d'erreur utiles affichés par le ROR (et générés par docutils)

Java - JRst

JRst est un analyseur Java reStructuredText. Il peut actuellement générer du HTML, XHTML, DocBook xdoc et PDF, MAIS semble poser de sérieux problèmes: ni la génération PDF ni le (X) HTML ne fonctionnent avec le téléchargement complet en cours, les pages de résultats en (X) HTML sont vides et PDF la génération échoue sur IO problèmes avec les fichiers XSL (non groupés ??). Notez que le JRst original a été supprimé du site Web; un fork est trouvé sur GitHub .

Scala - Laika

Laika est une nouvelle bibliothèque permettant de transformer les langages de balisage vers d'autres formats de sortie. Actuellement, il prend en charge les entrées de Markdown et de reStructuredText et produit une sortie HTML. La bibliothèque est écrite en Scala mais devrait également être utilisable à partir de Java.

Perl

PHP

C #/.NET

Nim/C

Le Nim compilateur contient les commandesrst2html Et rst2tex Qui transforment les fichiers reStructuredText en fichiers HTML et TeX. La bibliothèque standard fournit les modules suivants (utilisés par le compilateur) pour gérer les fichiers reStructuredText par programme:

  • rst - implémente un analyseur reStructuredText
  • rstast - implémente un AST pour l'analyseur reStructuredText
  • rstgen - implémente un générateur de HTML/Latex à partir de reStructuredText

Autres convertisseurs tiers

La plupart (mais pas tous) de ces outils sont basés sur Docutils (voir ci-dessus) et fournissent une conversion vers ou à partir de formats qui pourraient ne pas être pris en charge par la distribution principale.

De reStructuredText

  • restview - Ce paquet pip - installable python nécessite docutils, qui effectue le rendu. La principale caractéristique de facilité d'utilisation de restview est que, lorsque vous enregistrez les modifications apportées à votre/vos document (s), il les restaure et les réaffiche automatiquement. restview
    1. démarre un petit serveur web
    2. appelle docutils pour rendre vos documents au format HTML
    3. appelle le navigateur de votre appareil pour afficher le code HTML de sortie.
  • rst2pdf - de reStructuredText au format PDF
  • rst2odp - de reStructuredText à ODF Présentation
  • rst2beamer - de reStructuredText à LaTeX beamer Presentation class
  • Wikir - de reStructuredText à un Google (et éventuellement à d'autres) formats Wiki
  • rst2qhc - Convertissez une collection de fichiers reStructuredText en un fichier d'aide Qt (toolkit) et (facultatif) un fichier de projet d'aide Qt

Pour reStructuredText

  • xml2rst est un script XSLT permettant de convertir la représentation XML interne de Docutils (en arrière) en reStructuredText
  • Pandoc (voir ci-dessus) peut également convertir de Markdown, HTML et LaTeX vers reStructuredText
  • db2rst est un traducteur DocBook simple et limité à reStructuredText
  • pod2rst - convertit les fichiers .pod en fichiers reStructuredText

Les extensions

Certains projets utilisent reStructuredText comme base de référence ou fournissent des fonctionnalités supplémentaires étendant l'utilitaire des outils reStructuredText.

Sphinx

Le générateur de documentation Sphinx traduit un ensemble de fichiers source reStructuredText dans divers formats de sortie, générant automatiquement des références croisées, des index, etc.

rest2web

rest2web est un outil simple qui vous permet de créer votre site Web à partir d'un seul modèle (ou autant que vous le souhaitez) et de conserver le contenu dans reStructuredText.

Pygments

Pygments est un surligneur de syntaxe générique destiné à une utilisation générale dans tous les types de logiciels, tels que les systèmes de forum, les wikis ou d’autres applications, qui doivent rendre le code source plus esthétique. Voir Utilisation de Pygments dans les documents reStructuredText .

Editeurs Gratuits

Bien que tout texte brut editor soit approprié pour écrire des documents reStructuredText, certains éditeurs bénéficient d’un meilleur support que d’autres.

Emacs

Le support Emacs via rst-mode fait partie du paquet Docutils sous /docutils/tools/editors/emacs/rst.el

Vim

Le paquetage vim-common Correspondant à la plupart des distributions GNU/Linux prend en charge la surbrillance de la syntaxe reStructuredText et le support d'indentation de reStructuredText:

Jed

Il existe un premier mode pour l'éditeur de programmeurs Jed .

gedit

gedit, l'éditeur de texte officiel de l'environnement de bureau GNOME. Il y a un gedit reStructuredText plugin .

Geany

Geany , un environnement de développement intégré petit et léger inclut la prise en charge de reStructuredText à partir de version 0.12 (10 octobre 2007).

Leo

Leo , éditeur de plan pour les programmeurs, supporte reStructuredText via rst-plugin ou via "@ auto-rst" noeuds (ce n'est pas bien documenté, mais @ Les noeuds auto-premiers permettent l'édition directe des premiers fichiers, en analysant la structure dans le contour Leo).

Il fournit également un moyen de prévisualiser le code HTML résultant dans un volet "rendu rendu".

ETP

Le [~ # ~] fte [~ # ~] Folding Text Editor - un éditeur de texte libre (sous licence GNU GPL) pour les développeurs. FTE has a mode pour la prise en charge de reStructuredText. Il offre une mise en surbrillance des couleurs des éléments RSTX de base et un menu spécial qui permet d’insérer facilement les éléments RSTX les plus courants dans un document.

PyK

PyK est un successeur de PyEdit et de reStInPeace, écrit en Python à l'aide du toolkit Qt4.

Éclipse

Eclipse IDE avec le plug-in ReST Editor assure la prise en charge de la modification des fichiers reStructuredText.

NoTex

NoTex est un éditeur de texte basé sur un navigateur (à usage général), avec gestion de projet intégrée et mise en évidence de la syntaxe. De plus, il permet d'écrire des livres, des rapports, des articles, etc. à l'aide de rST et de les convertir en LaTex, PDF ou HTML. Les fichiers PDF ont une qualité de publication élevée et sont générés via Sphinx avec la suite Texlive LaTex.

Bloc-notes ++

Notepad ++ est un éditeur de texte à usage général pour Windows. Il a la coloration syntaxique intégrée à de nombreuses langues et la prise en charge de reStructuredText via un langue définie par l'utilisateur pour reStructuredText .

Code Visual Studio

Code Visual Studio est un éditeur de texte à usage général pour Windows/macOS/Linux. Il a la coloration syntaxique intégrée pour de nombreuses langues et supporte reStructuredText via une extension de LeXtudio .

Editeurs dédiés de reStructuredText

Editeurs propriétaires

Texte sublime

Sublime Text est un éditeur de code source entièrement personnalisable et extensible, disponible pour Windows, OS X et Linux. L'enregistrement est requis pour une utilisation à long terme, mais toutes les fonctions sont disponibles dans la version non enregistrée, avec des rappels occasionnels pour l'achat d'une licence. Les versions 2 et 3 (actuellement en version bêta) prennent en charge la coloration syntaxique reStructuredText par défaut, et plusieurs plugins sont disponibles via le gestionnaire de packages Package Control pour fournir des extraits et la complétion de code, une coloration syntaxique supplémentaire, la conversion vers/à partir de RST et d'autres formats, ainsi qu'un aperçu HTML dans le navigateur.

BBEdit/TextWrangler

BBEdit (et sa variante libre TextWrangler ) pour Mac peut mettre en évidence la syntaxe reStructuredText à l'aide de ceci module de langue sans code .

TextMate

TextMate , éditeur de texte GUI polyvalent et exclusif pour Mac OS X, possède un bundle pour reStructuredText .

Intype

Intype est un éditeur de texte propriétaire pour Windows, qui prend en charge reStructuredText directement.

E éditeur de texte

[~ # ~] e [~ # ~] est un éditeur de texte propriétaire sous licence "Open Company License". Il supporte les bundles de TextMate, il devrait donc supporter reStructuredText de la même manière que TextMate.

PyCharm

PyCharm (et d'autres IDE de la plate-forme IntelliJ?) Prend en charge ReST/Sphinx (coloration syntaxique, saisie semi-automatique et prévisualisation). instant preview )

Wiki

voici quelques programmes Wiki qui prennent en charge le balisage reStructuredText en tant que syntaxe de balisage natif ou en tant que complément:

MediaWiki

Extension de MediaWiki reStructuredText autorise le balisage reStructuredText dans MediaWiki entouré de <rst> Et </rst>.

MoinMoin

MoinMoin est un WikiEngine avancé, facile à utiliser et extensible avec une large communauté d’utilisateurs. En quelques mots, il s’agit d’une collaboration sur des pages Web facilement modifiables.

Il existe un analyseur reStructuredText pour MoinMoin .

Trac

Trac est un wiki amélioré et un système de suivi des problèmes pour les projets de développement logiciel. Il existe un support reStructuredText dans Trac .

Ce wiki

Ce Wiki est un Webware pour Python Wiki écrit par Ian Bicking. Ce wiki utilise ReStructuredText pour son balisage.

rstiki

rstiki est un wiki personnel minimaliste utilisant un seul fichier et utilisant la syntaxe reStructuredText (via docutils) inspiré par pwyky . Il ne prend pas en charge l’indication de l’auteur, la gestion des versions, la hiérarchie, les chromages/cadrages/modèles, ni les styles. Il utilise docutils/reStructuredText comme syntaxe wiki. En tant que tel, il est situé sous 200 lignes de code et dans un seul fichier. Vous le mettez dans un répertoire et il s'exécute.

ikiwiki

Ikiwiki est un compilateur wiki. Il convertit les pages wiki en pages HTML adaptées à la publication sur un site Web. Ikiwiki stocke les pages et l'historique dans un système de contrôle de révision tel que Subversion ou Git. Il existe de nombreuses autres fonctionnalités, y compris la prise en charge de blogs, ainsi qu'un grand nombre de plugins. C'est le plugin reStructuredText , mais il est quelque peu limité et n'est pas recommandé comme langage de balisage principal pour le moment.

Services Web

Bac à sable

Un éditeur en ligne reStructuredText peut être utilisé pour jouer avec le balisage et voir les résultats immédiatement.

Cadres de blogs

WordPress

plugin WordPreSt reStructuredText pour WordPress. (PHP)

Zine

plugin d'analyse syntaxique reStructuredText pour Zine (deviendra obsolète dans la version 0.2 lorsque Zine doit obtenir un support natif de reStructuredText). Zine est arrêté. (Python)

pélican

Pelican est un générateur de blog statique qui prend en charge la rédaction d'articles dans ReST. (Python)

hyde

Hyde est un générateur de site Web statique qui prend en charge ReST. (Python)

Acrylamid

Acrylamid est un générateur de blog statique qui prend en charge la rédaction d'articles dans ReST. (Python)

Nikola

Nikola est un générateur de site et de blog statique qui prend en charge ReST. (Python)

genres ipsum

genres Ipsum est un générateur de blog statique écrit en Nim.

Yozuch

Yozuch est un générateur de blog statique écrit en Python.

Plus

433
Chen Levy