Markdown
(
МФА
:
[
ˈ
m
ɑ
ː
k
d
a
ʊ
n
], произносится
маркда́ун
) —
облегчённый язык разметки
, созданный с целью обозначения форматирования в
простом тексте
, с максимальным сохранением его читаемости человеком, и пригодный для машинного преобразования в языки для продвинутых публикаций (
HTML
,
Rich Text
и других).
История
Первоначально создан в 2004 году
и
Аароном Шварцем
. Многие идеи языка были позаимствованы из существующих соглашений по разметке
текста
в
электронных письмах
. Реализации языка Markdown преобразуют текст в формате Markdown в
валидный
,
правильно построенный
XHTML
и заменяют левые угловые скобки («<») и
амперсанды
(«&») на соответствующие коды сущностей. Первой реализацией Markdown стала написанная Грубером реализация на
Perl
, однако спустя некоторое время появилось множество реализаций от сторонних разработчиков (см.
). Реализация на Perl распространяется по лицензии типа
BSD
. Реализации Markdown на различных
языках программирования
включены (или доступны в качестве
плагина
) во многие
системы управления содержимым
.
Примеры синтаксиса
Ниже приведены примеры использования Markdown, однако это далеко не полное руководство. Полное описание языка может быть найдено на официальном сайте
. Символы, которые обычно рассматриваются в 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
Расширения
Приведённые ниже приложения реализуют Markdown, расширяя его синтаксис дополнительной функциональностью:
-
MultiMarkdown (C)
-
Text::MultiMarkdown (Perl) модуль, реализующий расширение MultiMarkdown
-
PHP Markdown Extra
-
python-markdown2 (Поддерживает некоторые расширения PHP Markdown)
-
python-markdown (Имеет систему расширений для добавления нового синтаксиса)
-
Markout (Java)
-
Pegdown (Java)
-
Maruku (Ruby)
-
Pandoc (Haskell)
Руководства
-
Markdown: Dingus онлайн-конвертер
-
Markdown cheat sheet
Конвертеры
-
из HTML в Markdown
-
html2text.py (написано на
Python
)
-
Markdownify (на
PHP
)
-
Make.text —
букмарклет
, преобразующий любую веб-страницу в Markdown
-
XHTML-to-Markdown XSLT (XSLT-таблица стилей, работает только с XHTML)
-
Pandoc
— написанная на
Haskell
библиотека по преобразованию различных форматов, поддерживает несколько диалектов Markdown (
markdown
— диалект от pandoc,
markdown_strict
— оригинальный Markdown без расширений,
markdown_phpextra
— диалект от
PHP
,
markdown_github
— диалект от
github
) может преобразовывать из и в Markdown,
HTML
,
reStructuredText
,
LaTeX
, и другие.
-
Другие форматы в Markdown
Утилиты
-
(написанный на
Python
скрипт
для загрузки документов Markdown вместе с изображениями)
-
— плагин для Microsoft Word, позволяющий конвертировать DOCX документы в формат Markdown и наоборот.
-
Вики
:
-
Блоги
:
-
Tumblr
— изначально отключён, но можно использовать, включив в настройках.
-
-
CMS
:
-
Drupal
— content-фильтр Markdown
-
Magento
— с помощью модуля
-
Plone
— «родная» поддержка в Plone 3
-
TYPO3
— с помощью плагина af_markdown
-
— один из видов разметки, доступный «из коробки»
-
— по умолчанию используется для хранения контента (вместо баз данных)
-
Веб-фреймворки
:
-
Ruby on Rails
— требуется установка BlueCloth, Maruku
-
Yii
— виджет CMarkdown, входит в стандартную поставку фреймворка
-
— входит в стандартную поставку PHP-фреймфорка в виде плагина к бесплатному приложению «Блог»
-
Symfony
— требуется установка бандла KnpMarkdownBundle
-
Социальные приложения:
-
Системы управления проектами и кодом:
Поддержка текстовыми редакторами
-
Универсальные редакторы:
TextMate
,
(с версии 8.6),
Vim
(с помощью специального пользовательского режима
, написанного Беном Вильямсом),
Emacs
(с помощью специального пользовательского режима
, написанного Джейсоном Блевинсом),
,
,
Sublime Text
,
Geany
,
Atom
,
Visual Studio Code
.
-
Редакторы для блогов:
,
-
Плагины
для редактора среды
Eclipse
от ThinkTank Mathematics
-
Плагины для текстового редактора
gedit
-
Текстовый редактор
в версии для
Mac OS
и
Android
.
-
Текстовый редактор
для
Android
.
-
Текстовый редактор
для
GNU/Linux
-
WYSIWYM
-редактор
для
Windows
/
Mac OS
-
WYSIWYM
-редактор Typora для
Windows
,
GNU/Linux
и
Mac OS
Примечания
-
(англ.)
(1 августа 2014). Дата обращения: 16 июля 2020.
12 июля 2020 года.
-
(англ.)
.
Aaron Swartz: The Weblog
(19 марта 2004). Дата обращения: 16 июля 2020.
25 декабря 2019 года.
-
(неопр.)
. Дата обращения: 16 июля 2020.
15 июля 2020 года.
-
(неопр.)
. Daring Fireball. Дата обращения: 16 июля 2020.
17 июня 2020 года.
-
Leonard S.
(англ.)
—
IETF
, 2016. — 15 p. —
-
от 22 февраля 2011 на
Wayback Machine
(англ.)
-
-
(неопр.)
. Дата обращения: 4 июля 2018.
11 июня 2018 года.
-
(неопр.)
. Дата обращения: 29 мая 2008.
4 июня 2008 года.
-
(неопр.)
. Дата обращения: 8 апреля 2015.
1 августа 2015 года.
-
(неопр.)
. Дата обращения: 8 апреля 2015.
23 марта 2015 года.
-
(неопр.)
. Дата обращения: 9 апреля 2015.
20 мая 2018 года.
-
(неопр.)
. Дата обращения: 29 мая 2008. Архивировано из
23 ноября 2008 года.
-
(неопр.)
. Дата обращения: 29 мая 2008.
16 мая 2008 года.
-
(неопр.)
. Дата обращения: 15 октября 2013.
20 июня 2014 года.
-
↑
(неопр.)
. Дата обращения: 29 мая 2008. Архивировано из
26 августа 2007 года.
-
(неопр.)
. GitHub. Дата обращения: 28 января 2016.
17 февраля 2016 года.
-
↑
(неопр.)
. Дата обращения: 29 ноября 2017.
1 декабря 2017 года.
-
(неопр.)
. Дата обращения: 10 августа 2012.
21 августа 2013 года.
-
(неопр.)
. GitHub. Дата обращения: 29 ноября 2017.
11 июня 2018 года.
-
(неопр.)
. Дата обращения: 11 августа 2010.
22 июня 2013 года.
-
(неопр.)
. Дата обращения: 29 мая 2008.
16 мая 2008 года.
-
(недоступная ссылка)
-
-
(неопр.)
. Дата обращения: 29 мая 2008.
2 июня 2008 года.
-
↑
(неопр.)
. Дата обращения: 29 мая 2008. Архивировано из
24 мая 2008 года.
-
↑
(неопр.)
. Дата обращения: 17 мая 2018.
11 июня 2018 года.
-
13 июня 2008 года.
-
↑
(неопр.)
. Дата обращения: 29 мая 2008. Архивировано из
20 июня 2008 года.
-
(неопр.)
. Дата обращения: 5 сентября 2011.
27 августа 2011 года.
-
-
(неопр.)
. Дата обращения: 9 сентября 2012.
4 июля 2013 года.
-
-
(неопр.)
. Дата обращения: 29 мая 2008.
22 мая 2008 года.
-
(неопр.)
. Дата обращения: 29 мая 2008. Архивировано из
23 февраля 2008 года.
-
от 12 мая 2014 на
Wayback Machine
(англ.)
-
(неопр.)
. Дата обращения: 29 мая 2008.
12 июня 2008 года.
-
(неопр.)
. Дата обращения: 13 октября 2013.
12 октября 2013 года.
-
(неопр.)
. Дата обращения: 29 мая 2008.
9 мая 2008 года.
-
(неопр.)
. Дата обращения: 29 мая 2008. Архивировано из
5 июня 2008 года.
-
-
(неопр.)
. Дата обращения: 29 мая 2008.
4 июня 2008 года.
-
24 мая 2008 года.
-
(неопр.)
. Дата обращения: 29 мая 2008. Архивировано из
27 марта 2008 года.
-
(неопр.)
. Дата обращения: 11 июля 2021.
1 апреля 2021 года.
-
(неопр.)
. Дата обращения: 18 ноября 2010.
25 сентября 2010 года.
-
(неопр.)
. Дата обращения: 8 ноября 2015.
4 марта 2016 года.
-
(неопр.)
. Дата обращения: 29 мая 2008. Архивировано из
17 ноября 2006 года.
-
(неопр.)
. Дата обращения: 2 марта 2021. Архивировано из
4 июня 2006 года.
-
(неопр.)
. Дата обращения: 19 сентября 2018.
19 сентября 2018 года.
-
8 сентября 2008 года.
или
от 27 августа 2010 на
Wayback Machine
, который является развитием BlueCloth
-
(неопр.)
. Дата обращения: 24 ноября 2015.
14 января 2016 года.
-
(неопр.)
. Дата обращения: 24 ноября 2015.
30 ноября 2015 года.
-
от 18 сентября 2009 на
Wayback Machine
(англ.)
-
31 декабря 2009 года.
(англ.)
-
13 сентября 2009 года.
(англ.)
-
12 января 2012 года.
(англ.)
-
(рус.)
play.google.com. Дата обращения: 18 ноября 2018.
8 апреля 2019 года.
-
Gregor Santner.
. — 2022-07-04.
5 июля 2022 года.
-
11 ноября 2012 года.
(англ.)
-
от 14 октября 2012 на
Wayback Machine
(англ.)
-
от 11 марта 2020 на
Wayback Machine
Typora — a markdown editor, markdown reader.
|
Офисные
документы
|
|
Общеизвестные
|
|
Менее
известные
|
|