igor_pont
8.6 KiB
Особенности синтаксиса Markdown
Абзацы создаются при помощи пустой строки. Если вокруг текста сверху и снизу есть пустые строки, то текст превращается в абзац.
Чтобы сделать перенос строки вместо абзаца, нужно поставить два пробела в конце предыдущей строки.
Заголовки (h1)
заголовки (h2)
заголовки (h3)
заголовки (h4)
заголовки (h5)
заголовки (h6)
Списки
Для разметки неупорядоченных списков можно использовать * или - или +:
- элемент 1
- элемент 2
Вложенные пункты создаются четырьмя пробелами (или tab):
- элемент 1
- элемент 2
- вложенный элемент 2.1
- вложенный элемент 2.2
Упорядоченный список:
- элемент 1
- элемент 2
- вложенный 2.1
- вложенный 2.2
Список с абзацами (четыре пробела или один tab):
-
Раз абзац.
-
Два абзац.
-
Три абзац.
Цитаты
Цитаты оформляются как в емейлах, спомощью символа >.
Например:
Первая цитата
Вторая цитата
Третья цитата
Строки циатат можно объединять символом >.
Первая строка цитаты,
вторая строка цитаты,
третья строка цитаты.
В цитаты можно помещать любые элементы, в том числе и вложенные цитаты:
Заголовок цитаты
- Первая строка
- Вторая строка
Вложенная цитата
Вот пример кода...
Конец цитаты
Исходный код
В чистом Маркдауне блоки кода отбиваются 4 пробелами (или tab) в начале каждой строки.
Но в GitHub-Flavored Markdown (сокращенно GFM) есть более удобный способ: ставим по три апострофа до и после кода. Также можно указать язык исходного кода.
Пример:
<nav class="nav nav-primary">
<ul>
<li class="tab-conversation active">
<a href="#" data-role="post-count" class="publisher-nav-color" data-nav="conversation">
<span class="comment-count">0 комментариев</span>
<span class="comment-count-placeholder">Комментарии</span>
</a>
</li>
<li class="dropdown user-menu" data-role="logout">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
<span class="dropdown-toggle-wrapper">
<span>
Войти
</span>
</span>
<span class="caret"></span>
</a>
</li>
</ul>
</nav>
В таком случае в коде не нужно заменять угловые скобки < > и амперсанд & на их html-сущности.
Инлайн код
Для вставки кода внутри внутри предложений нужно заключать этот код в апострофы.
Пример: <html class="ie no-js">
Если внутри кода есть апостроф, то код необходимо обрамить двойными апострафами: There is a literal backtick (`) here.
Горизонтальная черта
hr создается тремя звездочками или тремя дефисами.
Пример:
Ссылки
Это встроенная ссылка с title элементом.
Это - без title элемента
А вот пример нескольких ссылок с разметкой как у сносок. Прокатит и короткая запись без указания id.
Вынос длинных урлов из предложения способствует сохранению читабельности исходника. Сноски можно располагать в любом месте документа.
Выделения текста
Выделять слова можно при помощи * и _. Один символ - для наклонного текста, два символа - для жирного текста, три символа - для наклонного и жирного одновременно.
Например:
наклонный и наклонный
жирный и жирный
жирный и наклонный
Зачеркивание текста
В GFM добавлено зачеркивание текста: две тильды ~ до и после текста.
Например:
Зачеркнуть
Добавление изображений
Чтобы добавить изображение без Alt текста нобходимо использовать следующую команду:
Например:
Картина с Alt и тайтлом добавляется следующей командой:
Запомнить просто: синтаксис как у ссылок, только перед открывающей квадратной скобкой ставится восклицательный знак.
Картинки "сноски" добавляются следующим способом:
Картинки-ссылки добавляются следующей командой:
[](http://адрес ресурса)
Использование HTML внутри Markdown
Можно смешивать Markdown и HTML. Если на какие-то элементы необходимо поставить классы или атрибуты, то смело используем HTML:
Выделять слова можно при помощи * и _ . Например, это italic и это тоже italic. А вот так уже strong, и так тоже strong.
Можно и наоборот, внутри HTML-тегов использовать Markdown.
Пример Маркдауна внутри HTML
Выделять слова можно при помощи * и _ . Например, это italic и это тоже italic. А вот так уже strong, и так тоже strong.
Работа с таблицами
В чистом Markdawn нет синтаксиса для таблиц, а в GFM есть.
| First Header | Second Header |
|---|---|
| Content Cell | Content Cell |
| Content Cell | Content Cell |
Для красоты можно и по бокам линии нарисовать, но суть от этого не поменяется:
| First Header | Second Header |
|---|---|
| Content Cell | Content Cell |
| Content Cell | Content Cell |
Для выравнивания столбцов можно использовать двоеточие:
| Left-Aligned | Center Aligned | Right Aligned |
|---|---|---|
| col 3 is | some wordy text | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat |
Внутри таблиц можно использовать ссылки, наклонный, жирный или зачеркнутый текст.