Підтримка інструменту reStructuredText


128

Я великий шанувальник reStructuredText , проте інструменти, які його підтримують, розкидані по всьому Інтернету. Офіційний список інструментів є неповним і / або застарілим, і може бути оновлений тільки через комміттерскіе привілеї. Деякий час на сторінці Wikipedia reStructuredText існував вичерпний список , однак це, мабуть, " не відповідало настановам про помітність веб-контенту " і було видалено .

Отже, щоб поставити його у формі запитання: Яку підтримку інструментів можна очікувати під час роботи з reStructuredText, наприклад, текстовими редакторами, програмним забезпеченням Wiki, перетворювачами до і з реструктуризованого тексту тощо?

Відповіді:


440

Виправлення (і розширення) списку зі старої версії сторінки Вікіпедії :

Документація

Впровадження

Хоча контрольна реалізація reStructuredText написана на Python, парсер reStructuredText є і на інших мовах.

Python - Docutils

Основним розповсюдженням реструктуризованого тексту є пакет Python Docutils . Він містить кілька інструментів перетворення:

  • rst2html - від reStructuredText до HTML
  • rst2xml - від reStructuredText до XML
  • rst2latex - від reStructuredText до LaTeX
  • rst2odt - від reStructuredText до документа ODF Text (текстовий процесор).
  • rst2s5 - від reStructuredText до S5 , система слайд-шоу на основі простих стандартів
  • rst2man - від reStructuredText до сторінки Man

Хаскелл - Пандок

Pandoc - це бібліотека Haskell для перетворення одного формату розмітки в інший та інструмент командного рядка, який використовує цю бібліотеку. Він може читати Markdown та (підмножини) reStructuredText, HTML та LaTeX, а також може записувати Markdown, reStructuredText, HTML, LaTeX, ConTeXt, PDF, RTF, DocBook XML, OpenDocument XML, ODT, GNU Texinfo, MediaWiki markup, groff man сторінок і слайд-шоу HTML S5.

Існує онлайн-інструмент Pandoc (POT), щоб спробувати цю бібліотеку. На жаль, порівняно з рендерером реструктуризованого тексту (ROR),

  • POT скорочує введення порівняно коротше. Користувач POT повинен відображати введення фрагментами, які ROR може бути виведений цілим.
  • У висновку POT бракує корисних повідомлень про помилки, які відображаються ROR (і генеруються користувачем docutils)

Java - JRst

JRst - аналізатор Java reStructuredText. В даний час він може виводити HTML, XHTML, DocBook xdoc і PDF, але, здається, не виникає серйозних проблем: ні PDF, ні (X) покоління HTML не працюють за допомогою поточного повного завантаження, сторінки результатів у (X) HTML порожні, а генерація PDF не працює на IO проблеми з файлами XSL (не в комплекті ??). Зверніть увагу, що оригінальний JRst був видалений з веб-сайту; на GitHub знаходиться вилка .

Скала - лайка

Laika - це нова бібліотека для перетворення мов розмітки в інші вихідні формати. В даний час він підтримує введення даних від Markdown і reStructuredText і виробляє вихід HTML. Бібліотека написана на Scala, але вона також може бути доступною для використання на Java.

Perl

PHP

  • Gregwar / RST - зрілий аналізатор PHP5.3 з тестами
  • php-restructuredtext - Проста, неповна (але функціональна) реалізація

C # /. NET

Нім / С

Nim компілятор відрізняє команди rst2html і rst2texякі перетворять ReStructuredText файли HTML і TeX файлів. Стандартна бібліотека надає наступні модулі (використовуються компілятором) для програмного управління файлами reStructuredText:

  • Перший - реалізує ReStructuredText аналізатор
  • rstast - реалізує AST для аналізатора reStructuredText
  • rstgen - реалізує генератор HTML / Latex з reStructuredText

Інші сторонні перетворювачі

Більшість цих інструментів (але не всі) базуються на документах (див. Вище) і забезпечують перетворення у формати або з них, які можуть не підтримуватися основним дистрибутивом.

З реструктуризованого тексту

  • restview - Цей pipпакунок -встановлення python вимагає docutils, що робить фактичне рендерінг. restviewОсновна функція простоти у використанні полягає в тому, що, коли ви зберігаєте зміни в документі (документах), він автоматично відтворюється та повторно відображається.restview
    1. запускає невеликий веб-сервер
    2. дзвінки docutilsдля надання ваших документів у HTML
    3. викликає браузер вашого пристрою для відображення вихідного HTML.
  • rst2pdf - від reStructuredText до PDF
  • rst2odp - від reStructuredText до презентації ODF
  • rst2beamer - від reStructuredText до класу презентації променів LaTeX
  • Wikir - від reStructuredText до Google (і, можливо, інших) форматів Wiki
  • rst2qhc - Перетворення колекції реструктуризованих файлів у файл довідки Qt (інструментарій) та (необов’язково) файл довідкового проекту Qt

Для реструктуризованого тексту

  • xml2rst - це сценарій XSLT для перетворення внутрішнього XML-представлення Docutils (назад) в reStructuredText
  • Pandoc (див. Вище) також може конвертувати з Markdown, HTML і LaTeX в reStructuredText
  • db2rst - це простий та обмежений перекладач DocBook для реструктуризованого перекладача
  • pod2rst - конвертувати .pod файли в reStructuredText файли

Розширення

Деякі проекти використовують reStructuredText як базову лінію для нарощування або надають додаткову функціональність, що розширює корисність інструментів reStructuredText.

Сфінкс

Sphinx генератор документації перетворює набір вихідних файлів ReStructuredText в різні формати, автоматично проводити перехресні посилання, індекси і т.д.

rest2web

rest2web - це простий інструмент, який дозволяє створювати веб-сайт за допомогою одного шаблону (або стільки, скільки вам потрібно), і зберігати вміст у reStructuredText.

Пігменти

Пігменти - це загальний підсвічувач синтаксису для загального використання у всіх видах програмного забезпечення, таких як форуми, вікі та інші додатки, які потребують уточнення вихідного коду. Див. Розділ Використання фрагментів у документах reStructuredText .

Безкоштовні редактори

Хоча будь-який редактор простого тексту підходить для написання документів reStructuredText, деякі редактори мають кращу підтримку, ніж інші.

Emacs

Підтримка Emacs через rst-режим поставляється як частина пакету Docutils під/docutils/tools/editors/emacs/rst.el

Вим

vim-commonПакет , який поставляється з більшістю дистрибутивів GNU / Linux має ReStructuredText підсвічування синтаксису і підтримку відступу ReStructuredText з коробки:

Джед

Існує перший режим для редактора програмістів Jed .

gedit

gedit, офіційний текстовий редактор робочого середовища GNOME. Існує плагін gedit reStructuredText .

Гені

Geany , невелике та полегшене середовище інтегрованого розвитку, включає підтримку reStructuredText з версії 0.12 (10 жовтня 2007 р.).

Лев

Лео , редактор контуру для програмістів, підтримує reStructuredText через rst -плагін або через вузли "@ auto-rst" (це не добре задокументовано, але @ вузли auto-rst дозволяють редагувати файли rst безпосередньо, розбираючи структуру в контур Лео) .

Він також пропонує спосіб попереднього перегляду отриманого HTML на панелі "перегляду".

FTE

FTE Текстовий редактор Folding - безкоштовний (під ліцензією GNU GPL) текстовий редактор для розробників. FTE має в режим для підтримки ReStructuredText. Він забезпечує кольорове виділення основних елементів RSTX та спеціальне меню, що забезпечує простий спосіб вставити в документ найпопулярніші елементи RSTX.

PyK

PyK є наступником PyEdit і reStInPeace, написаних на Python за допомогою інструментарію Qt4.

Затемнення

IDE Eclipse з плагіном редактора ReST забезпечує підтримку редагування файлів reStructuredText.

NoTex

NoTex - це текстовий редактор на базі браузера (загального призначення) з інтегрованим управлінням проектами та підсвічуванням синтаксису. Плюс це дозволяє писати книги, звіти, статті тощо за допомогою rST та конвертувати їх у LaTex, PDF або HTML. Файли PDF мають високу якість публікації та створюються через Sphinx за допомогою пакета Texlive LaTex.

Блокнот ++

Блокнот ++ - це текстовий редактор загального призначення для Windows. Він має підсвічування синтаксису для багатьох вбудованих мов та підтримку reStructuredText за допомогою визначеної користувачем мови для reStructuredText .

Код візуальної студії

Visual Studio Code - це текстовий редактор загального призначення для Windows / macOS / Linux. Він має підсвічування синтаксису для багатьох вбудованих мов і підтримує reStructuredText через розширення від LeXtudio .

Виділені редактори реструктуризованого тексту

Власні редактори

Піднесений текст

Sublime Text - це повністю настроюваний та розширюваний редактор вихідного коду, доступний для Windows, OS X та Linux. Реєстрація потрібна для тривалого використання, але всі функції доступні в незареєстрованій версії, з випадковими нагадуваннями про придбання ліцензії. Версії 2 та 3 (наразі у бета-версії) підтримують підсвічування синтаксису reStructuredText за замовчуванням, а кілька модулів доступні через керування пакунками менеджера пакунків, щоб забезпечити фрагменти та доповнення коду, додаткове підсвічування синтаксису, перетворення в / з RST та інших форматів та попередній перегляд HTML у браузері.

BBEdit / TextWrangler

BBEdit (та його безкоштовний варіант TextWrangler ) для Mac може виділити синтаксис reStructuredText за допомогою цього безкодичного мовного модуля .

TextMate

TextMate , власницький текстовий редактор GUI загального призначення для Mac OS X, має пакет для reStructuredText .

Інтип

Intype - власний текстовий редактор для Windows, який підтримує reStructuredText поза вікном.

E Текстовий редактор

E - власний текстовий редактор, що має ліцензію за ліцензією «Відкрита компанія». Він підтримує пакети TextMate, тому він повинен підтримувати reStructuredText так само, як це робить TextMate.

PyCharm

PyCharm (та інші IDE платформи IntelliJ?) Має підтримку ReST / Sphinx (підсвічування синтаксису, автозаповнення та попередній перегляд). миттєвий попередній перегляд)

Wiki

ось деякі програми Wiki, які підтримують розмітку reStructuredText як синтаксис власного розмітки або як доповнення:

MediaWiki

Розширення MediaWiki reStructuredText дозволяє проводити розмітку reStructuredText у MediaWiki в оточенні <rst>та </rst>.

MoinMoin

MoinMoin - це вдосконалений, простий у користуванні та розширюваний WikiEngine з великою спільнотою користувачів. У кількох словах йдеться про співпрацю на веб-сторінках, які легко редагуються.

Існує реструктуризований аналізатор тестування для MoinMoin .

Trac

Trac - це вдосконалена система wiki та відстеження випусків проектів розробки програмного забезпечення. У Trac є підтримка реструктуризованого тексту .

Це Wiki

Цей Wiki - це веб-програмне забезпечення для Python Wiki, яке написав Ян Бікінг. Ця вікі використовує ReStructuredText для своєї розмітки.

рстики

rstiki - мінімалістичний однофайловий персональний вікі, використовуючи синтаксис reStructuredText (через документи), натхненний pwyky . Він не підтримує вказівку на авторство, версію, ієрархію, хром / обрамлення / шаблонування чи стилізацію. Він використовує docutils / reStructuredText як синтаксис wiki. Таким чином, це під 200 рядків коду та в одному файлі. Ви поміщаєте його в каталог і він працює.

ikiwiki

Ikiwiki - компілятор wiki. Він перетворює сторінки вікі в HTML-сторінки, придатні для публікації на веб-сайті. Ikiwiki зберігає сторінки та історію в такій системі контролю версій, як Subversion або Git. Є багато інших функцій, включаючи підтримку ведення блогів, а також великий масив плагінів. Це плагін reStructuredText , однак дещо обмежений і не рекомендується наразі його основною мовою розмітки.

Веб-сервіси

Пісочниця

Редактор Інтернет ReStructuredText може бути використаний для відтворення з розміткою і побачити результати відразу.

Рамки блогів

WordPress

WordPreSt reStructuredText плагін для WordPress. (PHP)

Зіна

плагін для розбору reStructuredText для Zine (стане застарілим у версії 0.2, коли Zine планується отримати вбудовану підтримку reStructuredText). Зін припинено. (Пітон)

пелікан

Pelican - це статичний генератор блогу, який підтримує написання статей в ReST. (Пітон)

hyde

Hyde - це статичний генератор веб-сайтів, який підтримує ReST. (Пітон)

Акриламід

Acrylamid - це статичний генератор блогу, який підтримує написання статей у ReST. (Пітон)

Микола

Ніколас - Статичний генератор сайтів та блогів, який підтримує ReST. (Пітон)

ipsum родів

Ipsum roses - статичний генератор блогу, написаний у Німі.

Йозух

Yozuch - це статичний генератор блогу, написаний на Python.

Більше


Для PHP пакет документів документа Zeta Components має хорошу підтримку reStructuredText.
Роб Аллен

Можливо, вам також буде цікавий попередній перегляд , який трохи схожий на те, що пропонує Markedapp для документів Markdown. Це не інструмент reStructredText persé, але я вважаю це дуже корисним.
Вільфред Спрингер

1
Через коментар Емі Браун я дізнався, що ви можете встановити Marked.app для відображення першого, перейшовши на налаштування> поведінку, увімкнувши "спеціальний процесор Markdown" і вказуючи його на файл rst2html.py.
Шон

Час зробить цю відповідь і застарілою. Я перевірив лише кілька пропозицій, як-от PYK та RIP, які не можуть працювати на сьогоднішніх системах, оскільки вони залежать від застарілих модулів, тому ...
theta

3
Я додав посилання на vim addon riv.vim, яке мені забезпечує те, що я довго шукав. github.com/Rykka/riv.vim
Jan Vlcinsky
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.