Нотация Markdown

Справочник разметки текста Markdown предназначен специалистам, которым приходится оформлять техническую, прежде всего проектную, документацию. Такие специалисты, как правило, хорошо разбираются в предметной области, но не обладают глубокими знаниями и навыками технического редактирования. Справочник представляет собой описание нотации и практики применения языка разметки текста Markdown. Включает сведения необходимые и достаточные техническому писателю для оформления текстов и подготовки их к последующей публикации в форматах HTML, PDF, LaTeX, ODT,  Rich Text и других.

Данный справочник не является переводом официальной спецификации Markdown, а также не может служить учебником для тех, кто только знакомится с синтаксисом разметки Markdown. Это именно справочник, предназначенный для того, чтобы время от времени уточнить правила применения того или иного элемента текста.

Назначение нотации Markdown

Нотация Markdown представляет собой правила создания структуры текста с помощью специальных символов — элементов разметки.

Нотация Markdown создана для:

• облегчения труда авторам, занятым написанием текста;

• ввода данных пользователями приложений;

• структурирования текста, не отвлекаясь на визуальное оформление;

• сохранения читаемости структурированного текста человеком;

• переносимость (мобильность) размеченного текста в разные приложения и разные форматы публикации;

• пригодности автоматического преобразования размеченного текста в форматы публикаций (HTML, PDF, LaTeX, ODT,  Rich Text и т.п.);

• коллективного управления знаниями (проектная документация, обмен сообщениями и т.п.).

Достоинства нотации Markdown:

• Простой и запоминающийся синтаксис, который обеспечивает простоту изучения и освоения нотации.

• Интуитивность. Пользователь не ощущает перегрузки правил.

• Разумные значения по умолчанию. Автоматически обеспечена оптимизация производительности приложения, которое будет обрабатывать текст в нотации Markdown.

• Отсутствует привязка к поставщику проприетарного приложения. Писать и размечать текст можно простом текстовом редакторе.

• Отсутствует необходимость создания для текста стилевых таблиц CSS. Хотя существует возможность при желании использовать стилевые таблицы CSS.

Практика применения

В настоящее время широко применяют следующие диалекты Markdown: MultiMarkdown, Markdown Extra, common Mark,  Github Markdown (Github Flavoured Markdown, GFM), LiaScript, Maruku,  Kramdown, Redcarpet, rDiscount, Pandoc, Yandex Markdown (YFM) и другие.

Иногда применяют смешанную разметку страниц, сочетающую одновременное использование Markdown с другими нотациями. В данном справочнике рассматриваются случаи публикации страниц в интернете. С этой точки зрения представляет интерес:

• структурное форматирование — сочетание нотации Markdown с элементами HTML;

• визуальное форматирование — сочетание нотации Markdown с описанием стилей CSS.

Страницы

Нотация Markdown рассматривает любой сложный текст как группу страниц, связанных между собой гиперссылками.

Внутри страница текста представляет собой канву, в которую можно вставлять компоненты следующих типов:

• символы:

  • структурные элементы;

  • экранированные символы;

• строчные элементы;

• блочные элементы.

Каталоги и файлы

Каждая страница вне зависимости от количества содержащихся в ней знаков представляет собой запись в одном файле с расширением ".md". Например: "текст.md", "readme.md". Внутри файла не существует разбивки на страницы.