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

StackOverflow https://stackoverflow.com/questions/659227

Вопрос

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

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

Это было полезно?

Решение

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

Текстиль

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

Уценка

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

reStructuredText (А.К.А.Отдых)

  • Популярен в сообществе Python
  • 285 вопросов отмечены на Stack Overflow
  • Немного привередлив в отношении пробелов и выравнивания, если вы спросите меня.
  • Списки (особенно вложенные списки) и абзацы всегда конфликтуют.
  • Читается непрограммистами
  • Единственный формат, который может создавать оглавление (через расширение в эталонной реализации Python).
  • Непосредственное преобразование в другие форматы, такие как PDF и XML.
  • Идеально подходит для больших документов с большим количеством прозы (например,альтернатива docbook для руководства пользователя)
  • Справочник по синтаксису

Другие советы

Вы также можете рассмотреть асцидок

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

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

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

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

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

Обновлять

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

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

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

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

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top