Шпаргалка по markdown
Правила оформления wiki-страницы в стиле markdown
| Назначение | Синтаксис | Пример | Примечание |
|---|---|---|---|
| Абзац | Текст, окружённый пустыми строками | Первый абзацВторой абзац |
Отбивка одним или несколькими переводами строки |
| Перенос строки внутри абзаца | Два пробела в конце строки | строка1··строка2 |
·· обозначает два пробела. Альтернатива – тег <br> |
| Заголовки | # перед текстом, от 1 до 6 |
# H1## H2### H3 |
Также можно подчеркнуть === или --- на следующей строке (для H1 и H2) |
| Жирный текст | **текст** или __текст__ |
**жирный** → жирный |
Внутри слова можно использовать ** |
| Курсив | *текст* или _текст_ |
*курсив* → курсив |
|
| Жирный курсив | ***текст*** |
***важно*** → важно |
|
| Зачёркнутый | ~~текст~~ |
~~зачеркнуть~~ → ~~зачеркнуть~~ |
Поддерживается в GFM и многих расширениях |
| Встроенный код | `код` |
`print(x)` → print(x) |
Для символа обратного апострофа внутри кода используйте двойные обратные апострофы |
| Блок кода | Тройные обратные апострофы или отступ в 4 пробела | ```pythonprint("hi")``` |
Можно указать язык после открывающих ``` для подсветки синтаксиса |
| Цитата | > в начале строки |
> Цитируемый текст |
Вложенность – несколько > подряд |
| Нумерованный список | 1., 2. и т.д. |
1. Первый2. Второй |
Номера можно не соблюдать строго, движок сам пронумерует |
| Маркированный список | -, * или + |
- Элемент |
Символы взаимозаменяемы |
| Вложенные списки | Отступ в 4 пробела или 1 таб | - Пункт- Подпункт |
|
| Список задач (чек-лист) | - [ ] или - [x] |
- [x] Сделано- [ ] В процессе |
GFM и многие расширения, не часть оригинального Markdown |
| Горизонтальная линия | Три или более *, -, _ на отдельной строке |
--- |
Строка должна быть пустой сверху и снизу |
| Ссылка | [текст](url) или [текст][ref] |
[Google](https://google.com) |
Можно добавить тайтл: [текст](url "подсказка") |
| Ссылка-сноска | [текст][идентификатор] и позже [идентификатор]: url |
[1]: https://example.com |
Не все рендереры поддерживают |
| Изображение |  |
 |
Синтаксис похож на ссылку, но с восклицательным знаком |
| Экранирование | Обратный слеш \ перед символом |
\*не курсив\* → *не курсив* |
Экранирует любой специальный символ Markdown |
| Таблица | Трубы \| и дефисы - |
\| Заголовок \|\|----------\|\| Ячейка \| |
Выравнивание двоеточиями: :--- слева, :---: центр, ---: справа |
| Сырой HTML | Вставка HTML-тегов напрямую | <br> или <u>подчеркнуть</u> |
В безопасном режиме HTML может фильтроваться, в Django нужен |safe |
| Автоматическая ссылка | <url> или <email> |
<https://ya.ru> → https://ya.ru |
|
| Сноска (расширение) | [^1] в тексте и [^1]: определение |
Текст[^1]... [^1]: сноска |
Требуется расширение footnotes, в Python-Markdown доступно |
| Эмодзи (GFM) | :smile: |
:tada: → 🎉 |
Зависит от платформы |