Markdown

Markdown (МФА: [ˈmɑːkdaʊn], произносится маркда́ун) — облегчённый язык разметки, созданный с целью обозначения форматирования в простом тексте, с максимальным сохранением его читаемости человеком, и пригодный для машинного преобразования в языки для продвинутых публикаций (HTML, Rich Text и других).

Общие сведения
Markdown
Расширение .md,
.markdown[1]
MIME-тип text/markdown[5]
Разработчик Джон Грубер
Опубликован 19 марта 2004; 22 года назад (2004-03-19)[2][3]
Последний выпуск 17 декабря 2004; 21 год назад (2004-12-17)
Тип формата Язык разметки
Открытый формат? да[4]
Сайт daringfireball.net/proje…

История

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

Примеры синтаксиса

Ниже приведены примеры использования Markdown, однако это далеко не полное руководство. Полное описание языка может быть найдено на официальном сайте[6]. Символы, которые обычно рассматриваются в 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)[32]
  • Text::MultiMarkdown (Perl) модуль, реализующий расширение MultiMarkdown[33]
  • PHP Markdown Extra[34]
  • python-markdown2 (Поддерживает некоторые расширения PHP Markdown)[27]
  • python-markdown (Имеет систему расширений для добавления нового синтаксиса)[26]
  • Markout (Java)[35]
  • Pegdown (Java)[18]
  • Maruku (Ruby)[29]
  • Pandoc (Haskell)[16][36]

Руководства

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

Конвертеры

  • из HTML в Markdown
    • html2text.py (написано на Python)[39]
    • Markdownify (на PHP)[40]
    • Make.text — букмарклет, преобразующий любую веб-страницу в Markdown[41]
    • XHTML-to-Markdown XSLT (XSLT-таблица стилей, работает только с XHTML)[42]
    • Pandoc — написанная на Haskell библиотека по преобразованию различных форматов, поддерживает несколько диалектов Markdown (markdown — диалект от pandoc, markdown_strict — оригинальный Markdown без расширений, markdown_phpextra — диалект от PHP, markdown_github — диалект от github) может преобразовывать из и в Markdown, HTML, reStructuredText, LaTeX, и другие.[16]
  • Другие форматы в Markdown

Утилиты

  • Markdown tool (написанный на Python скрипт для загрузки документов Markdown вместе с изображениями)[45]
  • Writage — плагин для Microsoft Word, позволяющий конвертировать DOCX документы в формат Markdown и наоборот.

Веб-приложения, использующие Markdown

Поддержка текстовыми редакторами

Примечания

Категории

Markdown Syntax in gedit.png
Изображение логотипа