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

90

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

См. Также: Markdown против ReStructuredText

documentation markdown markup restructuredtext textile ДжейсонСмит
источник
1
См. Также superuser.com/questions/209897/text-formatter-tools/…
RedGrittyBrick

Ответы:

115

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

Текстиль

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

Markdown

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

reStructuredText (AKA ReST)

  • Популярно в сообществе Python
  • 285 вопросов с тегом Stack Overflow
  • Немного привередливо насчет пробелов и выравнивания, если вы спросите меня
  • Списки (особенно вложенные списки) и абзацы всегда становятся предметом споров.
  • Читается непрограммистами
  • Только формат, который может создавать оглавление (через расширение в эталонной реализации Python)
  • Непосредственно конвертирует в другие форматы, такие как PDF и XML
  • Идеально подходит для больших документов с большим количеством прозы (например, альтернатива docbook для руководства пользователя)
  • Справочник по синтаксису
ДжейсонСмит
источник
4
Для пользователей ReST sphinx.pocoo.org выглядит очень хорошим инструментом для больших древовидных коллекций справочной документации.
bendin
6
У меня нет проблем со списками и абзацами в reStructuredText, когда я жестко заворачиваю вещи в Emacs. Фактически, они работают именно так, как я ожидал :-)
Мартин Гейслер
1
Есть расширения для Markdown, которые позволяют составлять таблицы в ASCII.
Якуб Наребски,
1
ReST также имеет отличную поддержку инструментов: например, браузер notex.ch - это хороший инструмент для экспериментов, изучения и использования ReST (на основе серверной части sphinx.pocoo.org).
hsk81
31

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

  • относительно читаемая разметка
  • простое использование командной строки
  • некоторые могут посчитать это относительно «придирчивым» (а не гибким) в отношении синтаксиса
  • docbook и вывод (x) html
Дат
источник
2
К сожалению, asciidoc имеет ужасный синтаксис для элементов списка с несколькими абзацами: вы должны разделить их одной строкой, содержащей только знак плюса (да, «+»).
Мартин Гейслер
4
@Martin: Неужели элементы списка из нескольких абзацев так важны? Если вам нужно более одного абзаца, разве заголовки / разделы не будут более подходящими, чем список?
Steve S
Самым большим преимуществом AsciiDoc является то, что он поддерживает гораздо больше функций. Он может создавать книги, иметь разделы с советами
Wernight
21

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

техномалогический
источник
5

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

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

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

Обновить

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

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

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

Трэвис Х.
источник
4

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

mhd
источник