Сравните и сопоставьте облегченные языки разметки

Пожалуйста, определите самые популярные облегченные языки разметки и сравните их сильные и слабые стороны. Эти языки должны быть разметкой общего назначения для технической прозы, например, для документации (например, Haml не в счет).

См. также: Markdown и ReStructuredText


markdown markup documentation restructuredtext textile
person JasonSmith    schedule 18.03.2009    source источник
comment
См. также superuser.com/questions/209897/text-formatter-tools. /   -  person RedGrittyBrick    schedule 12.11.2010

Ответы (5)


arrow_upward
115
arrow_downward

Я знаю три основных языка, которые обычно используются в большом программистском и техническом сообществе: Textile, Markdown и reStructuredText. Все три можно выучить за пару часов или «окрылить» со шпаргалкой рядом.

Текстиль

  • Используется Redmine и сообществом Ruby
  • 113 вопросов, помеченных в настоящее время на Stack Overflow
  • Наиболее похожий на HTML, но наименее читаемый источник
  • Простейшие вложенные списки всех трех языков
  • Непонятен для непрограммистов или незнающих HTML
  • Идеально подходит для сложных коротких документов (со ссылками, вложенными списками, кодом, пользовательским HTML); например: краткая документация, инструкции, блог или содержимое CMS.
  • справочник по синтаксису

Уценка

  • Кажется, что у него нет "сообщества" на родном языке, но...
  • 1274 вопроса отмечены на Stack Overflow*
  • Подчеркивает читабельность исходного кода, аналогично традициям электронной почты.
  • Простое встраивание HTML (вы просто вводите теги)
  • Нет возможности создавать таблицы, кроме встраивания HTML
  • Вы уже это знаете, если знаете Stack Overflow
  • Легко учиться, если вы уже знаете reStructuredText
  • Автоматическое запутывание адресов электронной почты в формате ‹[email protected]› (с угловыми скобками)
  • Справочник по синтаксису

reStructuredText (он же ReST)

  • Популярен в сообществе Python
  • 285 вопросов, помеченных на Stack Overflow
  • Немного придирчив к пробелам и выравниванию, если вы спросите меня
  • Списки (особенно вложенные списки) и абзацы всегда конфликтуют.
  • Читается не программистами
  • Единственный формат, который может создавать оглавление (через расширение в эталонной реализации Python)
  • Непосредственно конвертирует в другие форматы, такие как PDF и XML.
  • Идеально подходит для больших документов с большим количеством прозы (например, альтернатива docbook для руководства пользователя)
  • Справочник по синтаксису
person JasonSmith    schedule 18.03.2009
comment
Для пользователей ReST sphinx.pocoo.org выглядит очень хорошим инструментом для больших древовидных коллекций справочная документация. - person bendin; 18.03.2009
comment
У меня нет проблем со списками и абзацами в reStructuredText, когда я жестко оборачиваю вещи в Emacs. На самом деле, они работают именно так, как я и ожидал :-) - person Martin Geisler; 28.06.2009
comment
Существуют расширения Markdown, которые позволяют составлять таблицы в ASCII. - person Jakub Narębski; 23.09.2011
comment
ReST также имеет отличную поддержку инструментов: например. браузер на основе notex.ch — хороший инструмент для экспериментов, изучения и использования ReST (на основе файла sphinx.pocoo. оргбэкэнд). - person hsk81; 25.09.2012

arrow_upward
31
arrow_downward

Вы также можете рассмотреть asciidoc

  • относительно читаемая разметка
  • простое использование командной строки
  • некоторые могут воспринимать его как относительно «придирчивый» (по сравнению с гибким) в отношении синтаксиса.
  • docbook и (x)html вывод
person dat    schedule 25.05.2009
comment
К сожалению, asciidoc имеет ужасный синтаксис для элементов списка с несколькими абзацами: вы должны разделить их одной строкой, содержащей только знак плюс (да, +). - person Martin Geisler; 28.06.2009
comment
@Martin: Действительно ли элементы списка из нескольких абзацев так важны? Если вам нужно больше одного абзаца, не будут ли заголовки/разделы более подходящими, чем список? - person Steve S; 15.06.2011
comment
Самым большим преимуществом AsciiDoc является то, что он поддерживает гораздо больше функций. Он может создавать книги, иметь разделы с советами, множество выходных данных... powerman.name/doc/asciidoc - person Wernight; 24.09.2012

arrow_upward
21
arrow_downward

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

person technomalogical    schedule 27.07.2010

arrow_upward
5
arrow_downward

Я пытаюсь охватить здесь все различные облегченные языки разметки:

http://www.subspacefield.org/~travis/static_blog_generators.html

Как видите, все началось с вопроса «Как мне создать безопасный блог», то есть тот, который генерирует статический HTML, и я оказался в ловушке языков разметки, систем шаблонов и т. д.

Обновить

Я переориентировался только на LWML с реализациями Python, и они здесь:

http://www.subspacefield.org/~travis/python_lightweight_markup_languages.html

До сих пор я пробовал уценку и ReST, и последний мне больше нравится для всего, кроме фрагментов HTML, встроенных в другие страницы. Таблицы, перекрестные ссылки, непрямые ссылки и т. д.

person Travis H.    schedule 08.06.2010

arrow_upward
4
arrow_downward

для документации? как насчет doxygen?
Я использовал его для некоторых проектов c/c++, которые мне нужно документировать. Даже вы можете «злоупотреблять» им, как автор doxygen использует для документации doxygen.

person mhd    schedule 18.07.2009