≡ Краткое руководство Markdown
Абзац Markdown. Пример:
Lorem ipsum dolor sit amet... Абзацы создаются при помощи пустой строки.
Для переноса строки делаем два пробела в конце (предыдущей) строки
Перенос строки
Получается? Отлично! 👍
Текст с жирным начертанием (strong) и курсив (italic) в Markdown:
1 символ _ или * для наклонного текста
2 символа __ или ** для жирного текста
3 символа ___ или *** для наклонного и жирного одновременно.
Перечеркнутый текст. 2 тильды ~ до и после текста - текст как перечеркнутый - Зачеркнуто
Горизонтальная черта. hr - 3 звездочки или 3 дефиса
♦ Маркированный список. Для разметки неупорядоченных списков *, -, +:
- текст
- текст
- текст
Вложенные пункты. 4 пробела перед маркером:
- элемент маркированного списка
- элемент маркированного списка
- вложенный текст
- вложенный текст
Нумерованный список. Главное, чтобы перед элементом списка стояла цифра с точкой.
- элемент нумерованного списка
- элемент нумерованного списка
- вложенный
- вложенный
Можно сделать так:
- текст
- текст
- текст
Список с абзацами:
-
Текст
-
Текст
-
Текст
Текст (4 пробела или
Tab).
Здесь - ссылка с title.
Здесь - ссылка без title.
Ссылки с разметкой как у сносок.
Здесь - ссылка продолжение текста ссылка продолжение текста ссылка. Просто ссылка без указания id.
Ссылки-сноски можно располагать в любом месте документа.
Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet.
Lorem ipsum dolor sit amet.
В цитаты можно помещать всё что угодно, в том числе вложенные цитаты:
- список
- список
Вложенная цитата.
Исходный код (4 пробела в начале строки):
$source = file_get_contents('example.php');
В GFM - поставить 3 апострофа (где Ё) до и после кода. Можно указать язык исходного кода.
<div class="as-header">
<h1>Матрёшка</h1>
<p>Lorem ipsum dolor sit amet.</p>
</div> $(function() { ... });Для вставки кода внутри предложений - надо обрамить в апострофы (где Ё).
Пример: <div class="as-markdown">.
Если внутри кода есть апостроф, то код надо обрамить двойными апострофами: Бла-бла (`) тут.
Картинка без alt текста
Картинка с alt и title:
Картинка-ссылка: Подсказка: синтаксис как у ссылок, только перед открывающей квадратной скобкой ставится восклицательный знак.
Картинки-сноски:
Mожно смешивать Markdown и HTML. Если на какие-то элементы нужно поставить классы или атрибуты, используем HTML:
Выделим слова без помощи * и _ . Например, это курсив и это тоже курсив. А вот так уже strong, и так тоже strong.
Можно и наоборот, внутри HTML-тегов использовать Markdown.
Выделять слова можно при помощи * и _ . Например, это курсив и это тоже italic. А вот так уже strong, и так тоже strong.
В чистом Маркдауне нет синтаксиса для таблиц, а в 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 | какой-то текст | my text |
| col 2 is | центр | $123 |
| Content Cell | бука |
Внутри таблиц можно использовать ссылки, наклонный, жирный или зачеркнутый текст.
♦ Для всего остального есть обычный HTML.
- markdown-it for Markdown parsing
- CodeMirror for the awesome syntax-highlighted editor
- Live (Github-flavored) Markdown Editor
- highlight.js for syntax highlighting in output code blocks
- js-deflate for gzipping of data to make it fit in URLs