Синтаксис «Маркдаун»


Ниже рассмотрим базовый синтаксис разметки текстовых файлов «Маркдаун» — используемые символы, ссылки, абзацы, строфы, заголовки, цитаты, списки, преформатированный текст, изображения.


В общепринятом на данный момент базовом «Маркдаун» нет некоторых элементов HTML, как, например, определения, таблицы. Но в этом есть своя логика и правда. Потому что если, например, добавить таблицы, то многие начнут снова верстать визуальный вид этими таблицами, как это было с HTML. В конце концов, простые таблицы можно создавть, например, преформатированием.

Хотя появляются различные сторонние расширенные версии «Маркдаун», как, например, Maruku, Kramdown, которые пытаются расширить базовый «Маркдаун». Главное, помнить, что «Маркдаун» не создавался как замена HTML, и важно не растерять в процессе его развития основные принципы этой разметки.

Символы для разметки «Маркдаун»

В разметке гипертекста «Маркдаун» используются вспомогательные общие символы, но при этом не используются символы какого-либо алфавита — в первую очередь английского. Что в принципе, при хорошо продуманной национальной раскладке клавиатуры, позволит практически не переключать раскладку при создании и наборе текста веб-странички.

Список символов «Маркдаун»:

*         «звёздочка»  
_         подчёркивание  
+         плюс  
-         минус  
=         равно  
`         обратная кавычка  
()[]{}<>  скобки  
#         «решётка»  
!         восклицательный знак  
:         двоеточие  
|         вертикальная черта  
“         двойные кавычки  
'         апостроф  
$         доллар  
          пробел  
          новый абзац

В «Маркдаун» эти символы и служат для форматирования структуры текста, аналогично использованию HTML элементов.

При этом следует учитывать, что в «Маркдаун» в большинстве случаев нет закрывающих символов, и действие символа, обозначающего какой-либо элемент текста, распространяется до конца абзаца.

Если есть необходимость в этих символах непосредственно в обычном тексте, то, эти символы нужно экранировать обратной чертой \. Или же использовать разметку «преформатированный текст».

Базовые элементы «Маркдаун»

Абзац и перевод строки

Абзацы в «Маркдаун» отделяются друг от друга одним или несколькими пустыми строками.

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

Строка1
Строка2
Строка3

То есть строка набирается так: строка\s\s\n, где \s - пробел, \n - абзац. Другими словами это замена тега <BR> в HTML.

Заголовки

Заголовки обозначаются знаком # («решётка») в начале абзаца. Количество решёток обозначает уровень заголовка от одного до шести. Например:

# Заголовок

Соответствует HTML-коду

<h1>Заголовок</h1>

А, например, четыре решётки

### Заголовок

соответствует HTML-коду

<h4>Заголовок</h4>

Главный заголовок можно не выделять хешами, а подчеркнуть двойной линией:

Главный заголовок
=================

Второй по плавности заголовок можно подчеркнуть простой линией:

Обычный заголовок
-----------------

Стилизация текста

Жирный текст — **Жирный текст**
Курсивный текст — *Курсивный текст*
Жирный курсивный текст — ***Жирный курсивный текст***

или

Жирный текст — __Жирный текст__
Курсивный текст — _Курсивный текст_

Горизонтальная линия

Горизонтальная линия <hr> делается из серии трёх и более коротких тире

---

Цитаты

Перед цитатой в «Маркдаун» ставится угловая скобка >. Действует до конца абзаца

> «Следующее поколение веб-разработчиков будет жить при "Маркдауне"». М. Астапчик

Аналогично в HTML

<blockquote>«Следующее поколение веб-разработчиков будет жить при "Маркдауне"». М. Астапчик</blockquote>

Списки

Обычный ненумерованный список обозначается звёздочкой в начале каждого элемента списка

* Раз
* Два
* Три 

Для нумерованного списка используются цифры

1 Раз
2 Два
3 Три 

Форматирование кода, преформатированный текст

Очень важное в «Маркдаун» форматирование, которое означает текст как есть, без трансляции в HTML. Соответствует элементам pre и code в HTML. Для преформатированного абзаца достаточно сделать отступ в четыре пробела или один таб.

print("Hello world!\n")

Так же блок преформатированного текста можно обозначить тремя подряд обратными кавычками в начале и конце этого блока. То есть здесь требуются и закрывающий набор символов.

``` print("Hello world!\n")

```

Преформатированный текст непосредственно в строке выделяется с двух сторон обратными кавычками.

`преформатированный текст`

Легко использовать преформатированный текст в «Маркдаун».

Ссылки

В «Маркдаун» текст ссылки заключается в квадратные кавычки, после чего в круглых кавычках располагается адрес ссылки.

[Ссылка на котика](www.belursus.info/src/cat.md)

Ссылки-сноски

В обычном тексте не всегда эстетично вставлять ссылки прямо в текст, так как они могут быть очень длинными. Гораздо лучше их оформлять в виде сносок для лучшей читабельности. Сноска организуется с использованием квадратных кавычек. А внизу документа, как в книгах, каждой сноске после двоеточия указывается настоящий адрес ссылки. Пример:

Ссылка на [котика][1] через сноску

--- конец документа ---
[1]: www.belursus.info/src/cat.md "Котик"

А при трансляции в HTML эта синтаксическая конструкция будет анологична обычной ссылке

Ссылка на <a href="www.markdown.belursus.info/src/cat.md" title="Котик">котика</a> через сноску

Изображения

Ссылка на изображение такая же, как и обычная ссылка, но помечается впереди восклицательным знаком

![Даже котикам понятен «Маркдаун»](www.belursus.info/src/cat.jpg)

Что аналогично коду изображения в HTML

<img src="www.belursus.info/src/cat.jpg" title="Даже котикам понятен «Маркдаун»">

Очевидно, что использование изображений в «Маркдаун» в качестве декоративных элементов не предусмотрено.

Обычный HTML

Если что-то нельзя сделать с использованием «Маркдаун», то используйте обычный HTML.

Ⓜ ⬇ 2015 - 2017