Русская Википедия:Markdown
Markdown (МФА: Шаблон:МФА2, произносится маркда́ун) — облегчённый язык разметки, созданный с целью обозначения форматирования в простом тексте, с максимальным сохранением его читаемости человеком, и пригодный для машинного преобразования в языки для продвинутых публикаций (HTML, Rich Text и других).
История
Первоначально создан в 2004 году Шаблон:Iw и Аароном Шварцем. Многие идеи языка были позаимствованы из существующих соглашений по разметке текста в электронных письмах. Реализации языка Markdown преобразуют текст в формате Markdown в валидный, правильно построенный XHTML и заменяют левые угловые скобки («<») и амперсанды («&») на соответствующие коды сущностей. Первой реализацией Markdown стала написанная Грубером реализация на Perl, однако спустя некоторое время появилось множество реализаций от сторонних разработчиков (см. ниже). Реализация на Perl распространяется по лицензии типа BSD. Реализации Markdown на различных языках программирования включены (или доступны в качестве плагина) во многие системы управления содержимым.
Примеры синтаксиса
Ниже приведены примеры использования Markdown, однако это далеко не полное руководство. Полное описание языка может быть найдено на официальном сайте[1]. Символы, которые обычно рассматриваются в Markdown как специальные, могут быть экранированы с помощью обратного слеша. Например, последовательность «\*» выведет символ «*», а не будет являться признаком начала выделенного текста. Кроме того, Markdown не преобразует текст внутри «сырых» блоков XHTML. Таким образом, в Markdown-документ можно включать секции XHTML, заключив их предварительно в теги уровня блока.
Текст с выделением или логическим ударением
*выделение* (например, курсив)
**сильное выделение** (например, полужирное начертание)
Программный код
Элементы кода могут быть внутри строки (inline) либо многострочными блоками.
Внутри строки код выделяется символом "`" (обратный апостроф).
Пример кода внутри строки (inline) `Hello world!`
Многострочный блок кода обозначается отступом из 4 пробелов или одного Tab.
Ниже начинается многострочный блок кода
<!doctype html>
<html>
<head>
<!-- Заголовок документа -->
</head>
<body>
<!-- Тело документа -->
</body>
</html>
Блок кода завершился
Зачёркнутый текст
необходимо сделать ~~одну~~ другую вещь
Списки
* элемент маркированного списка
- ещё один элемент ненумерованного списка
+ буллеты элементов могут быть разными
1. Элемент нумерованного списка
2. Элемент №2 того же списка
9. Элемент №3 списка — элементы нумеруются по порядку, цифра в начале строки не имеет значения
Заголовки
Создание заголовков производится путём помещения знака решетки перед текстом заголовка. Количество знаков «#» соответствует уровню заголовка. HTML предоставляет 6 уровней заголовков.
# Заголовок первого уровня
...
### Заголовок третьего уровня
...
###### Заголовок шестого уровня
Первые два уровня заголовка также имеют альтернативный синтаксис:
Заголовок первого уровня
========================
Заголовок второго уровня
------------------------
Цитаты (тег blockquote)
> Данный текст будет заключен в HTML-теги <blockquote></blockquote>
Ссылки
[Текст ссылки](http://example.com/ "Необязательный заголовок ссылки")
Альтернативный способ задавать ссылки, если есть повторения:
Где-то среди текста встречается [текст ссылки][example].
Также ссылка повторяется [пример адреса][example].
Ссылка на [второй][foo] также [Bar][] ресурсы.
[example]: http://example.com/ "Необязательный заголовок ссылки"
[foo]: http://example.net/ 'Необязательный заголовок ссылки'
[bar]: http://example.edu/ (Необязательный заголовок ссылки)
Изображения
![Alt-текст](http://example.com/ "Заголовок изображения")
Реализации Markdown
- C#[2][3]
- C[4][5][6][7]
- ColdFusion[8]
- Common Lisp[9]
- Go[10]
- Haskell[11]
- Java[12][13]
- JavaScript[14]
- Kotlin[15][16]
- Lua[17]
- newLISP[18]
- Perl[19]
- PHP[20]
- Python[21][22]
- Ruby[23][24]
- Scala[25]
- Tcl[26]
Расширения
Приведённые ниже приложения реализуют Markdown, расширяя его синтаксис дополнительной функциональностью:
- MultiMarkdown (C)[27]
- Text::MultiMarkdown (Perl) модуль, реализующий расширение MultiMarkdown[28]
- PHP Markdown Extra[29]
- python-markdown2 (Поддерживает некоторые расширения PHP Markdown)[22]
- python-markdown (Имеет систему расширений для добавления нового синтаксиса)[21]
- Markout (Java)[30]
- Pegdown (Java)[13]
- Maruku (Ruby)[24]
- Pandoc (Haskell)[11][31]
Руководства
Конвертеры
- из HTML в Markdown
- html2text.py (написано на Python)[34]
- Markdownify (на PHP)[35]
- Make.text — букмарклет, преобразующий любую веб-страницу в Markdown[36]
- XHTML-to-Markdown XSLT (XSLT-таблица стилей, работает только с XHTML)[37]
- Pandoc — написанная на Haskell библиотека по преобразованию различных форматов, поддерживает несколько диалектов Markdown (
markdown
— диалект от pandoc,markdown_strict
— оригинальный Markdown без расширений,markdown_phpextra
— диалект от PHP,markdown_github
— диалект от github) может преобразовывать из и в Markdown, HTML, reStructuredText, LaTeX, и другие.[11]
- Другие форматы в Markdown
- odt2txt (написанный на Python скрипт для преобразования файлов из формата OpenDocument в Markdown)[38]
- word_markdown_macro (макрос Microsoft Word, преобразующий некоторую часть форматирования Word в Markdown)[39]
Утилиты
- Markdown tool (написанный на Python скрипт для загрузки документов Markdown вместе с изображениями)[40]
- Writage — плагин для Microsoft Word, позволяющий конвертировать DOCX документы в формат Markdown и наоборот.
Веб-приложения, использующие Markdown
- Вики:
- Блоги:
- Tumblr — изначально отключён, но можно использовать, включив в настройках.
- scriptogr.am
- CMS:
- Веб-фреймворки:
- Ruby on Rails — требуется установка BlueCloth, Maruku[46]
- Yii — виджет CMarkdown, входит в стандартную поставку фреймворка
- Webasyst — входит в стандартную поставку PHP-фреймфорка в виде плагина к бесплатному приложению «Блог»
- Symfony — требуется установка бандла KnpMarkdownBundle
- Социальные приложения:
- Discord — приложение для публичного общения.
- Steemit — социальная сеть, основанная на блокчейне.
- Telegram — популярный кросс-платформенный мессенджер.
- WhatsApp — популярный кросс-платформенный мессенджер.
- Element.io (бывший Riot.im) — защищённый кросс-платформенный мессенджер, работающий по федеративному протоколу Matrix.
- Системы управления проектами и кодом:
Поддержка текстовыми редакторами
- Универсальные редакторы: TextMate, BBEdit (с версии 8.6), Vim (с помощью специального пользовательского режима[47], написанного Беном Вильямсом), Emacs(с помощью специального пользовательского режима[48], написанного Джейсоном Блевинсом), TextWrangler, Smultron, Sublime Text, Geany, Atom, Visual Studio Code.
- Редакторы для блогов: Ecto[49], MarsEdit
- Плагины для редактора среды Eclipse от ThinkTank Mathematics[50]
- Плагины для текстового редактора gedit[51]
- Текстовый редактор iA Writer в версии для Mac OS[52] и Android[53].
- Текстовый редактор Markor для Android[54].
- Текстовый редактор ReText для GNU/Linux[55]
- WYSIWYM-редактор Texts для Windows/Mac OS[56]
- WYSIWYM-редактор Typora для Windows, GNU/Linux и Mac OS [57]
Примечания
Шаблон:Языки разметки документов
- ↑ Описание синтаксиса Markdown Шаблон:WaybackШаблон:Ref-en
- ↑ Markdownsharp
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ 11,0 11,1 11,2 Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ 13,0 13,1 Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ The Search Engine that Does at InfoWeb.netШаблон:Недоступная ссылка
- ↑ Text::Markdown — search.cpan.org
- ↑ Шаблон:Cite web
- ↑ 21,0 21,1 Шаблон:Cite web
- ↑ 22,0 22,1 Шаблон:Cite web
- ↑ BlueCloth Шаблон:Webarchive
- ↑ 24,0 24,1 Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ The CAIUS project has a pure Tcl package for processing Markdown
- ↑ Шаблон:Cite web
- ↑ Text::MultiMarkdown — search.cpan.org
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ markdown от Pandoc против стандартного markdown Шаблон:WaybackШаблон:Ref-en
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Make.text
- ↑ Шаблон:Cite web
- ↑ Markdown in Python: odt2txt Шаблон:Webarchive
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ The Search Engine that Does at InfoWeb.net Шаблон:Webarchive или RDiscount Шаблон:Wayback, который является развитием BlueCloth
- ↑ Шаблон:Cite web
- ↑ Шаблон:Cite web
- ↑ Ecto, редактор для блогов Шаблон:WaybackШаблон:Ref-en
- ↑ Markdown-плагин для редактора среды Eclipse Шаблон:WebarchiveШаблон:Ref-en
- ↑ Markdown-плагин для текстового редактора gedit Шаблон:WebarchiveШаблон:Ref-en
- ↑ iA Writer для Mac Шаблон:WebarchiveШаблон:Ref-en
- ↑ Шаблон:Cite web
- ↑ Шаблон:Статья
- ↑ ReText — text editor for Markdown and reStructuredText Шаблон:WebarchiveШаблон:Ref-en
- ↑ Texts — rich editor for plain text Шаблон:WaybackШаблон:Ref-en
- ↑ https://typora.io/ Шаблон:Wayback Typora — a markdown editor, markdown reader.