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

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

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

5 89
documentation r-markdown restructuredtext semantic-markup textile

5 ответов:

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

текстильной

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

Markdown

  • не похоже, что есть родной язык "сообщество", но...
  • 1274 вопросов, помеченных на стеке Переполнение*
  • подчеркивает удобочитаемость исходного кода, аналогичную традициям электронной почты
  • простое встраивание HTML (вы просто вводите теги)
  • нет способа сделать таблицы, кроме встраивания HTML
  • вы уже знаете, если вы знаете переполнение стека
  • легко узнать, если вы уже знаете reStructuredText
  • автоматическое запутывание адреса электронной почты для формата
    (с углом скобки)
  • ссылка на синтаксис

reStructuredText (A. K. A. ReST)

  • популярный в сообществе Python
  • 285 вопросов, помеченных на переполнение стека
  • немного придирчивы к пробелам и выравниванию, если вы спросите меня
  • списки (особенно вложенные списки) и абзацы всегда, кажется, попадают в драки
  • читается не программистами
  • только формат, который может построить таблицу содержания (через расширение в реализации ссылки Python)
  • непосредственно преобразуется в другие форматы, такие как PDF и XML
  • идеально подходит для больших документов с большим количеством прозы (например, Альтернатива docbook для руководства пользователя)
  • ссылка на синтаксис
114

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

  • относительно читаемой разметки
  • простое использование командной строки
  • некоторые могут воспринимать его как относительно " придирчивый "(против гибкого) в отношении синтаксиса
  • docbook и (x)html вывод
31

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

21

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

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

обновление

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

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

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

5

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

4