Markdown

Материал из Википедии — свободной энциклопедии
Перейти к: навигация, поиск

Markdown (маркдаун) — облегчённый язык разметки. Первоначально создан в 2004 году Джоном Грубером (англ. John Gruber) и Аароном Шварцем, целью которых являлось создание максимально удобночитаемого и удобного в публикации облегчённого языка разметки. Многие идеи языка были позаимствованы из существующих соглашений по разметке текста в электронных письмах. Реализации языка Markdown преобразуют текст в формате Markdown в валидный, правильно построенный XHTML и заменяют левые угловые скобки («<») и амперсанды («&») на соответствующие коды сущностей. Первой реализацией Markdown стала написанная Грубером реализация на Perl, однако спустя некоторое время появилось множество реализаций от сторонних разработчиков (см. ниже). Реализация на Perl распространяется по лицензии типа BSD. Реализации Markdown на различных языках программирования включены (или доступны в качестве плагина) во многие системы управления содержимым.

Примеры синтаксиса[править | править исходный текст]

Ниже приведены примеры использования Markdown, однако это далеко не полное руководство. Полное описание языка может быть найдено на официальном сайте.[1] Символы, которые обычно рассматриваются в Markdown как специальные, могут быть экранированы с помощью обратного слеша. Например, последовательность «\*» выведет символ «*», а не будет являться признаком начала выделенного текста. Кроме того, Markdown не преобразует текст внутри «сырых» блоков XHTML. Таким образом, в Markdown-документ можно включать секции XHTML, заключив их предварительно в теги уровня блока.

  • Текст с выделением или логическим ударением:
 *выделение* (например, курсив)
 **сильное выделение** (например, полужирное начертание)
  • Программный код:
 `какой_то_программный_код($аргумент)`
    какой_то_программный_код_с_отступом_от_начала_строки_4_знака
  • Списки:
 * элемент маркированного списка
 - ещё один элемент ненумерованного списка
 + буллеты элементов могут быть разными
 1. Элемент нумерованного списка
 2. Элемент №2 того же списка
 9. Элемент №3 списка — элементы нумеруются по порядку, цифра в начале строки не имеет значения
  • Заголовки:

Создание заголовков производится путём помещения знака решетки перед текстом заголовка. Количество знаков «#» соответствует уровню заголовка. HTML предоставляет 6 уровней заголовков.

# Заголовок первого уровня
#### Заголовок четвёртого уровня

Первые два уровня заголовка также имеют альтернативный синтаксис:

Заголовок первого уровня
========================
Заголовок второго уровня
------------------------
  • Цитаты (тег blockquote):
>Данный текст будет заключен в HTML-теги <blockquote></blockquote>
> Данный текст будет заключен в HTML-теги <blockquote></blockquote>
  • Ссылки:
[Текст ссылки](адрес://ссылки.здесь "Заголовок ссылки")

или

[Текст ссылки][тег]

и где-нибудь в документе (например в самом низу)

[тег]: адрес://ссылки.здесь "Заголовок ссылки"
  • Изображения:
[Alt-текст]([[URL]] изображения "Заголовок изображения")

Реализации Markdown[править | править исходный текст]

Расширения[править | править исходный текст]

Приведённые ниже приложения реализуют Markdown, расширяя его синтаксис дополнительной функциональностью:

  • MultiMarkdown (C) [20]
  • Text::MultiMarkdown (Perl) модуль, реализующий расширение MultiMarkdown [21]
  • PHP Markdown Extra[22]
  • python-markdown2 (Поддерживает некоторые расширения PHP Markdown)[16]
  • python-markdown (Имеет систему расширений для добавления нового синтаксиса)[15]
  • Markout (Java)[23]
  • Pegdown (Java)[9]
  • Maruku (Ruby)[18]
  • Pandoc (Haskell)[7][24]

Руководства[править | править исходный текст]

  • Markdown: Dingus онлайн-конвертер[25]
  • Markdown cheat sheet[26]

Конвертеры[править | править исходный текст]

  • из HTML в Markdown
    • html2text.py (написано на Python)[27]
    • Markdownify (на PHP)[28]
    • Make.text (букмарклет, преобразующий любую веб-страницу в Markdown)[29]
    • XHTML-to-Markdown XSLT (XSLT-таблица стилей, работает только с XHTML)[30]
    • Pandoc (написанная на Haskell библиотека по преобразованию различных форматов, может преобразовывать из и в Markdown, HTML, reStructuredText, LaTeX, и другие)[7]
  • Другие форматы в Markdown

Веб-приложения, использующие Markdown[править | править исходный текст]

  • Вики:
  • Блоги:
    • Tumblr — изначально отключён, но можно использовать, включив в настройках.
    • scriptogr.am
  • CMS:
    • Drupal — content-фильтр Markdown[33]
    • Plone — «родная» поддержка в Plone 3
    • TYPO3 — с помощью плагина af_markdown[34]
    • RadiantCMS — один из видов разметки, доступный «из коробки»[35]
  • Веб-фреймворки:
    • Ruby on Rails — требуется установка BlueCloth, Maruku[36]
    • Yii — виджет CMarkdown, входит в стандартную поставку фреймворка
    • Webasyst — входит в стандартную поставку PHP-фреймфорка в виде плагина к бесплатному приложению «Блог»

Поддержка текстовыми редакторами[править | править исходный текст]

Примечания[править | править исходный текст]

  1. Описание синтаксиса Markdown (англ.)
  2. Announcing Markdown.NET
  3. Discount — a C implementation of the Markdown markup language
  4. CFX_Markdown | Seb Duggan
  5. CL-Markdown — Markdown and More
  6. Blackfriday: a markdown processor for Go
  7. 1 2 3 Pandoc — About pandoc
  8. MarkdownJ | Download MarkdownJ software for free at SourceForge.net
  9. 1 2 Pegdown
  10. Showdown — A JavaScript port of Markdown
  11. http://www.frykholm.se/files/markdown.lua
  12. The Search Engine that Does at InfoWeb.net
  13. Text::Markdown — search.cpan.org
  14. PHP Markdown
  15. 1 2 Markdown in Python: Overview
  16. 1 2 python-markdown2 — Project Hosting on Google Code
  17. BlueCloth
  18. 1 2 Maruku: a Markdown-superset interpreter
  19. MarkWrap — Unified Scala wrapper API for various lightweight markup APIs
  20. MultiMarkdown
  21. Text::MultiMarkdown - search.cpan.org
  22. PHP Markdown Extra
  23. Markout: Markout
  24. markdown от Pandoc против стандартного markdown (англ.)
  25. Daring Fireball: Markdown Web Dingus
  26. warpedvisions.org :: Markdown cheat sheet
  27. html2text: THE ASCIINATOR (aka html2txt)
  28. Markdownify: The HTML to Markdown converter for PHP
  29. Make.text
  30. Elements or Lower :: Geekery : XML : XHTML-to-Markdown.html
  31. Markdown in Python: odt2txt
  32. ProgTips " Blog Archive " Word to Markdown converter
  33. Markdown filter for Drupal | drupal.org
  34. typo3.org: Repository
  35. RadiantCMS
  36. The Search Engine that Does at InfoWeb.net или RDiscount, который является развитием BlueCloth
  37. Markdown Vim Mode | PlasticBoy
  38. Ecto, редактор для блогов (англ.)
  39. Markdown-плагин для редактора среды Eclipse (англ.)
  40. Markdown-плагин для текстового редактора gedit (англ.)
  41. iA Writer для Mac (англ.)
  42. ReText — text editor for Markdown and reStructuredText (англ.)
  43. Texts — rich editor for plain text (англ.)