Базовый синтаксис Markdown для оформления материалов.
Markdown - это облегчённый язык разметки, который преобразует текст в структурированный HTML. Следующее руководство поможет вам разобраться, как использовать Markdown.
Заголовки
В синтаксисе Markdown предусмотрено шесть уровней заголовков: H1 — самый крупный, H6 — самый мелкий. Чтобы обозначить уровень заголовка, используются символ #. При этом есть некоторые особенности:
- Символ «решётка» должен стоять только перед заголовком;
- Количество символов «решётка» указывает на уровень заголовка: одна решётка для первого уровня, две — для второго и так далее;
- Между символа «решётка» и текстом должен быть пробел.
Разметка
# Заголовок первого уровня
## Заголовок второго уровня
### Заголовок третьего уровня
#### Заголовок четвёртого уровня
##### Заголовок пятого уровня
###### Заголовок шестого уровняРезультат
# Заголовок первого уровня (h1) ## Заголовок второго уровня (h2) ### Заголовок третьего уровня (h3) #### Заголовок четвёртого уровня (h4) ##### Заголовок пятого уровня (h5) ###### Заголовок шестого уровня (h6)
Параграфы и переносы строк
Чтобы разделить текст на абзацы, необходимо оставить пустую строку между ними. Даже если в строке есть пробелы или табуляции, она всё равно будет считаться пустой. Если же строки расположены рядом, они автоматически объединяются в одну.
Для переноса строки внутри одного параграфа используется используется символ \.
Разметка
Это параграф. Чтобы создать новый параграф, оставьте пустую строку между двумя строками текста.
Это первая строка \
И это вторая строка, но они находятся в одном параграфе. Для переноса строки используйте символ `\` в конце предыдущей строки.Результат
Это параграф. Чтобы создать новый параграф, оставьте пустую строку между двумя строками текста.
Это первая строка
И это вторая строка, но они находятся в одном параграфе. Для переноса строки используйте символ \ в конце предыдущей строки.
Выделение текста
Чтобы изменить начертание текста, нужно заключить его в специальные символы с двух сторон: <символ>текст<символ>:
- Для выделения текста курсивом нужно использовать одну звёздочку
* - Для выделения текста жирным нужно использовать две звёздочки
** - Для выделения текста сразу курсивом и жирным нужно использовать три звёздочки
*** - Чтобы зачеркнуть текст, нужно использовать две тильды
~~
| Markdown | HTML | Результат |
|---|---|---|
Я обожаю **выделенный жирным шрифтом текст**. | Я просто обожаю <b>выделенный жирным шрифтом текст</b>. | Я обожаю выделенный жирным шрифтом текст. |
Выделенный курсивом текст - это *просто песня*. | Выделенный курсивом текст - это <i>просто песня</i>. | Выделенный курсивом текст − это кошачье мяуканье. |
Очень срочно и ***действительно важно***. | Очень срочно и <b><i>действительно важно</i></b>. | Очень срочно и действительно важно |
Так это ~~невыполнимая задача~~. | Так это <del>невыполнимая задача</del> | Так это |
Списки
В синтаксисе Markdown существует несколько видов списков. Чтобы их создать, необходимо перед каждым пунктом поставить соответствующий символ и отделить его от остального текста пробелом.
Нумерованный список
Разметка
1. Пункт первый
2. Пункт второй
3. Пункт третийРезультат
- Пункт первый
- Пункт второй
- Пункт третий
Маркированный список
Разметка
- Пункт первый
- Пункт второй
- Пункт третийРезультат
- Пункт первый
- Пункт второй
- Пункт третий
Вложенные списки
Для разметки вложенных списков, добавляя 4 пробела(Tab) перед пунктом:
Разметка
1. Пункт первый
- Подпункт первый
- Подпункт второй
2. Пункт второйРезультат
- Пункт первый
- Подпункт первый
- Подпункт второй
- Пункт второй
Список задач
Для разметки списка задач, необходимо использовать маркированный список, но между маркером и текстом поставить [x] для отмеченного пункта и [] — для неотмеченного.
Разметка
- [x] Задача 1
- [ ] Задача 2
- [ ] Задача 3Результат
- Задача 1
- Задача 2
- Задача 3
Ссылки
Самый лёгкий способ поместить ссылку в Markdown — заключить её в угловые скобки.
Разметка
[Текст ссылки](https://www.example.com)Результат:
Использование атрибута title
При необходимости вы можете добавить заголовок к ссылке. Он будет отображаться как всплывающая подсказка, когда пользователь наведёт курсор на ссылку. Чтобы добавить заголовок, нужно заключить его в кавычки сразу после URL-адреса.
Разметка
[Текст ссылки "Заголовок ссылки"](https://www.example.com)Результат
Безанкорные ссылки
Чтобы быстро преобразовать URL-адрес или адрес электронной почты в ссылку, необходимо заключить строку в угловые скобки.
Разметка
<https://www.altmoble.org>
<name@example.com>Результат
https://karkas.chat
fake@karkas.chat
Изображение
Изображения в Markdown оформляются по принципу, схожему с принципом оформления ссылок, только перед квадратными скобками нужно поставить восклицательный знак: .
Результат
Чтобы подписать (caption) изображение, используйте следующий разметку Markdown:
Результат
Таблицы
Разметка таблиц в формате Markdown: столбцы разделяются вертикальными линиями |, а строка с шапкой отделяется от остальных дефисами -, которых можно ставить сколько угодно:
Разметка
| Заголовок 1 | Заголовок 2 | Заголовок 3 |
| ----------- | ----------- | ----------- |
| Ячейка 1 | Ячейка 2 | Ячейка 5 |
| Ячейка 3 | Ячейка 4 | Ячейка 6 |Результат
| Заголовок 1 | Заголовок 2 | Заголовок 3 |
|---|---|---|
| Ячейка 1 | Ячейка 2 | Ячейка 5 |
| Ячейка 3 | Ячейка 4 | Ячейка 6 |
Чтобы выровнять весь столбец по правому краю, нужно поставить двоеточие после каждого дефиса в строке с дефисами. Если нужно выровнять содержимое по центру, двоеточия следует поставить с обеих сторон.
Разметка
| Заголовок 1 | Заголовок 2 | Заголовок 3 |
| ----------- | :---------: | ----------: |
| Ячейка 1 | Ячейка 2 | Ячейка 5 |
| Ячейка 3 | Ячейка 4 | Ячейка 6 |Результат
| Заголовок 1 | Заголовок 2 | Заголовок 3 |
|---|---|---|
| Ячейка 1 | Ячейка 2 | Ячейка 5 |
| Ячейка 3 | Ячейка 4 | Ячейка 6 |
Цитаты
Чтобы параграф отобразился как цитата, нужно поставить перед ним закрывающую угловую скобку >.
Разметка
> Это пример цитаты,
> в которой перед каждой строкой
> ставится угловая скобка.
> Это пример цитаты,
> в которой угловая скобка
> ставится только перед началом нового параграфа.
> Второй параграф.Результат
Это пример цитаты, в которой перед каждой строкой ставится угловая скобка.
Это пример цитаты, в которой угловая скобка ставится только перед началом нового параграфа.
Второй параграф.
Разметка
> Первый уровень цитирования
>
> > Второй уровень цитирования
> >
> > > Третий уровень цитирования
>
> Первый уровень цитированияРезультат
Первый уровень цитирования
Второй уровень цитирования
Третий уровень цитирования
Первый уровень цитирования
Блоки кода
Вы можете выделить код или команду в предложении, используя одинарные кавычки. Текст, заключённый в обратные кавычки, не форматируется. Кроме того, чтобы вставить обратные кавычки для блока кода в строке Markdown, вы можете воспользоваться сочетанием клавиш COMMAND + E (Mac) или CTRL + E (Linux/Window):
Разметка
Use `git status` to list all new or modified files that haven't yet been committed.Результат
Use git status to list all new or modified files that haven't yet been committed.
Чтобы выделить код или текст в отдельный блок, обратитесь к рекомендациям на странице «Возможности VitePress».
Игнорирование форматирования Markdown
При разметке текста вы можете указать, что нужно игнорировать (или экранировать) форматирование с помощью обратного слэша (\) перед символом Markdown.
Разметка
Let's rename \*our-new-project\* to \*our-old-project\*.Результат
Let's rename *our-new-project* to *our-old-project*.
Символы, которые можно экранировать
Вы можете использовать обратный слэш для экранирования следующих символов.
| Символ | Имя |
|---|---|
\ | Обратная косая черта |
* | Звёздочка |
_ | Подчёркивание |
{ } | Фигурные скобки |
[ ] | Квадратные скобки |
< > | Угловые скобки |
( ) | Круглые скобки |
# | Решётка |
+ | Знак плюса |
- | Знак минуса |
. | Точка |
! | Восклицательный знак |
| | Вертикальная черта |