Markdown на одной странице.Что вы пишете и что получаете.

Заголовки, текст и переносы строк

Пустая строка начинает новый абзац. Одиночный перенос строки внутри абзаца игнорируется, и строки склеиваются. Чтобы принудительно перенести, закончите строку двумя пробелами или обратной косой чертой.

Списки, списки задач и таблицы

- Milk
- Bread
  - Rye
  - Wheat

1. Open the folder
2. Pick a file

- [x] Write the plan
- [ ] Review it

Маркированный список начинает каждую строку с -, * или +. Для вложенности сделайте отступ в два или четыре пробела. В нумерованном списке верным должен быть только первый номер. Список задач — это маркированный список с [ ] или [x] в начале, он показывается флажками.

| Plan  | Price | Users |
|-------|------:|:-----:|
| Free  |    $0 |   1   |
| Team  |   $12 |  10   |

В таблице вторая строка отделяет заголовок от строк. :--- выравнивает столбец по левому краю, ---: по правому, а :---: по центру. Столбцы в тексте не обязаны стоять ровно. Чтобы поставить | внутри ячейки, напишите \|.

Код

Код в строке заключайте в одинарные обратные кавычки. Для блока поставьте три обратные кавычки в строке до и в строке после, а после открывающих напишите язык, чтобы получить подсветку синтаксиса:

```swift
let greeting = "Hello"
```

Блок с пометкой diff подсвечивает строки, начинающиеся с + и -. Блок с пометкой mermaid становится диаграммой.

Ссылки и изображения

[DotMD](https://getdotmd.com)
![A cat on a keyboard](assets/cat.png)
[the plan](plan.md)
[setup](#setup)

У ссылки текст стоит в квадратных скобках, а адрес в круглых. Веб-адрес сам по себе тоже становится ссылкой. Изображение — это ссылка с ! впереди; его текст описывает картинку для программ экранного чтения. Пути отсчитываются от документа, а ссылка может вести на другой .md-файл или на заголовок, чей якорь — его текст строчными буквами с пробелами, замененными на -.

Для длинных или повторяющихся адресов вынесите их вниз и ссылайтесь по короткому имени: [guide][1], затем [1]: https://example.com/guide в отдельной строке.

Врезки, комментарии и front matter

> [!NOTE]
> Useful information that users should know.

Цитата, первая строка которой — [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] или [!CAUTION], становится цветным блоком, с тем же синтаксисом, что на GitHub.

• Комментарии, которые не видны на странице: <!-- a note only visible in the text -->.
• Сворачиваемые разделы через HTML-теги <details> и <summary>, с пустыми строками вокруг Markdown внутри.
• Front matter: блок между двумя строками --- в самом начале файла, с названием, тегами или статусом. DotMD показывает его карточкой Properties над документом.

Формулы и диаграммы

Два расширения, которые рисуют и GitHub, и DotMD. Формула стоит между знаками доллара, $E = mc^2$, или между двойными в отдельной строке: формулы в Markdown на LaTeX. Диаграмма — это блок кода с пометкой mermaid и текстом внутри: диаграммы Mermaid.

Попробуйте

Быстрее всего выучить знаки, увидев их отрисованными. Откройте любой .md-файл в DotMD и читайте его отформатированным, с таблицами, кодом, врезками, диаграммами и формулами. Чтение бесплатно. В редакторе символы за вас вводит меню Insert, так что ничего из этого помнить не нужно.

Вопросы о синтаксисе Markdown

Другие вопросы