Как пользоваться Markdown
Markdown позволяет оформлять текст с помощью простых символов: создавать заголовки, выделять важное, добавлять списки, таблицы, ссылки, код и математические формулы.
Рекомендации
- Для обычной статьи обычно достаточно двух-трех уровней заголовков.
- Для акцента используйте жирный текст, а не дополнительные заголовки.
- Для последовательности действий используйте нумерованный список.
- Для перечисления равнозначных пунктов используйте маркированный список.
- Имена функций, параметры, команды и небольшие фрагменты программного кода оформляйте как код.
- Для структурированных данных используйте таблицы.
- Сложные математические выражения лучше помещать отдельным блоком между
$$. - Оставляйте пустые строки между крупными блоками текста — так исходная разметка легче читается.
Краткая шпаргалка
| Что нужно | Как написать | Как будет выглядеть | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Заголовки |
# Заголовок первого уровня ## Заголовок второго уровня ### Заголовок третьего уровня #### Заголовок четвертого уровня |
Чем больше символов Заголовок первого уровня
Заголовок второго уровня
Заголовок третьего уровня
Заголовок четвертого уровня
| ||||||||||||
| Жирный текст |
**Важный текст** |
Важный текст Используйте для основных акцентов и важных значений. | ||||||||||||
| Курсив |
*Дополнительное пояснение* |
Дополнительное пояснение | ||||||||||||
| Жирный курсив |
***Очень важный текст*** |
Очень важный текст | ||||||||||||
| Зачеркнутый текст |
~~Старый вариант~~ |
Удобно для обозначения отмененного или замененного варианта. | ||||||||||||
| Жирное выделение части предложения |
Статус заявки: **Подтверждена**. |
Статус заявки: Подтверждена. | ||||||||||||
| Несколько выделений |
**Статус:** выполнено. *Комментарий:* проверка не требуется. |
Статус: выполнено. | ||||||||||||
| Маркированный список |
- Первый пункт - Второй пункт - Третий пункт |
| ||||||||||||
| Вложенный маркированный список |
Для каждого следующего уровня добавляется отступ перед дефисом. - Документы - Справка - Счет - Отчеты - Доходность - Продажи |
| ||||||||||||
| Несколько уровней вложенности |
- Разделы
- Документы
- Справка
- Счет
- Отчеты
- Продажи
- Настройки
- Пользователи
|
| ||||||||||||
| Нумерованный список |
Перед каждым пунктом достаточно поставить 1. Получить данные 1. Проверить данные 1. Сформировать результат 1. Отправить результат Номера вручную указывать не нужно. |
Markdown автоматически пронумерует пункты:
Если добавить новый пункт в середину, перенумеровывать остальные строки не потребуется. | ||||||||||||
| Нумерованный список: до и после |
Пишем: 1. Первый шаг 1. Второй шаг 1. Третий шаг |
Получаем:
| ||||||||||||
| Вложенный нумерованный список |
Для вложенного уровня добавляется отступ. 1. Подготовить данные 1. Проверить заполнение 1. Проверить даты 1. Выполнить расчет 1. Проверить результат |
| ||||||||||||
| Смешанный список |
Можно вкладывать маркированный список в нумерованный. 1. Проверить заявку - ФИО - Даты - Категорию номера 1. Рассчитать стоимость 1. Подтвердить заявку |
| ||||||||||||
| Список задач |
- [x] Требования согласованы - [x] Разработка выполнена - [ ] Провести тестирование - [ ] Выпустить обновление |
☑ Требования согласованы | ||||||||||||
| Цитата |
> Обратите внимание: после изменения настройки необходимо повторно открыть форму. |
| ||||||||||||
| Многострочная цитата |
> Важное замечание. > > Здесь можно дать более подробное пояснение. > > И еще один абзац. |
| ||||||||||||
| Код внутри текста |
Для получения значения используется функция `ПолучитьДанные()`. |
Для получения значения используется функция | ||||||||||||
| Имена параметров и значений |
Проверьте параметр `accessToken`. Значение должно быть `Истина`. Используется `Справочники.Контрагенты`. |
Проверьте параметр | ||||||||||||
| Блок кода |
```
Сообщить("Привет!");
```
|
Код будет показан отдельным блоком: Сообщить("Привет!");
| ||||||||||||
| Код 1С |
После трех обратных кавычек можно указать язык ```bsl
Если ЗначениеЗаполнено(Контрагент) Тогда
Сообщить(Контрагент);
КонецЕсли;
```
|
Если ЗначениеЗаполнено(Контрагент) Тогда
Сообщить(Контрагент);
КонецЕсли;
| ||||||||||||
| JSON |
```json
{
"success": true,
"status": "ready",
"count": 10
}
```
|
{
"success": true,
"status": "ready",
"count": 10
}
| ||||||||||||
| Ссылка с названием |
[Сайт Кинт](https://kint.ru) |
Пользователь видит название ссылки, а не длинный адрес. | ||||||||||||
| Обычная интернет-ссылка |
https://kint.ru |
|||||||||||||
| Ссылка внутри предложения |
Подробное описание находится на [сайте Кинт](https://kint.ru). |
Подробное описание находится на сайте Кинт. | ||||||||||||
| Таблица |
| Параметр | Значение | Описание | |---|---|---| | Статус | Активен | Текущий статус | | Количество | 10 | Количество записей | | Дата | 23.08.2026 | Дата изменения | |
Первая строка содержит заголовки колонок. Вторая строка из дефисов отделяет заголовок от данных. | ||||||||||||
| Выравнивание в таблице |
Двоеточие указывает сторону выравнивания: | Наименование | Количество | Сумма | |:---|---:|---:| | Услуга 1 | 2 | 1 500 | | Услуга 2 | 1 | 750 | |
| ||||||||||||
| Таблица с форматированием |
В ячейках таблицы можно использовать другую Markdown-разметку. | Параметр | Значение | |---|---| | Статус | **Активен** | | Метод | `ПолучитьДанные()` | |
| ||||||||||||
| Горизонтальный разделитель |
--- |
Удобно отделять крупные смысловые части текста. | ||||||||||||
| Формула внутри строки |
Площадь круга равна $S = \pi r^2$. |
Площадь круга равна S = πr². Формула отображается непосредственно внутри текста. | ||||||||||||
| Примеры формул |
$E = mc^2$
$a^2 + b^2 = c^2$
$x_1 + x_2 = -\frac{b}{a}$
|
E = mc² | ||||||||||||
| Формула отдельным блоком |
Для большой формулы используются двойные знаки $$
x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$
|
Формула будет показана отдельным математическим блоком. Такой вариант рекомендуется для больших и сложных выражений. | ||||||||||||
| Дробь |
$\frac{1}{2}$
$\frac{Сумма}{Количество}$
|
Формулы будут отображены как обычные математические дроби. | ||||||||||||
| Степень и нижний индекс |
$x^2$
$x_1$
$a_{12}$
$x^{10}$
|
Степень: x² | ||||||||||||
| Квадратный корень |
$\sqrt{25}$
$\sqrt{x^2 + y^2}$
|
Формулы отображаются с математическим знаком квадратного корня. | ||||||||||||
| Математические символы |
$\pi$ $\pm$ $\le$ $\ge$ $\neq$ $\infty$ |
π — число пи | ||||||||||||
| Экранирование специальных символов |
Если символ Markdown нужно показать как обычный текст, поставьте перед ним обратный слеш \# Это не заголовок \*Это не курсив\* Цена составляет \$100. |
Будет показан обычный текст: # Это не заголовок *Это не курсив* Цена составляет $100. | ||||||||||||
| Обычный абзац |
Для нового абзаца оставьте пустую строку: Первый абзац. Второй абзац. Третий абзац. |
Первый абзац. | ||||||||||||
| Комбинирование разметки |
Разные виды разметки можно использовать одновременно: ## Результат обработки **Статус:** успешно Выполнены следующие действия: 1. Получены исходные данные. 1. Выполнена проверка. 1. Сформирован результат. > Обратите внимание: результат необходимо проверить перед публикацией. Основной параметр: `СтатусОбработки`. - [x] Получить данные - [x] Выполнить обработку - [ ] Проверить ошибки |
Результат обработки
Статус: успешно Выполнены следующие действия:
Основной параметр: ☑ Получить данные | ||||||||||||
| Пример оформления результата |
## Результат расчета **Период:** август 2026 **Итого:** 125 000 руб. ### Состав суммы | Вид услуги | Сумма | |---|---:| | Лечение | 100 000 | | Дополнительные услуги | 25 000 | > Сумма рассчитана по зарегистрированным документам оплаты. - [x] Данные получены - [x] Расчет выполнен - [ ] Требуется проверка |
Результат расчета
Период: август 2026 Состав суммы
☑ Данные получены |
Заголовки
Чем больше символов #, тем ниже уровень заголовка.
# Заголовок первого уровня ## Заголовок второго уровня ### Заголовок третьего уровня #### Заголовок четвертого уровня
Обычно достаточно использовать первые три уровня.
Жирный текст
Чтобы выделить важную мысль, заключите текст в двойные звездочки.
**Важный текст**
Как будет отображаться:
Важный текст
Курсив
Для курсива используются одинарные звездочки.
*текст курсивом*
Как будет отображаться:
текст курсивом
Жирный курсив
Можно объединить жирное начертание и курсив.
***очень важный текст***
Как будет отображаться:
очень важный текст
Зачеркнутый текст
Используйте двойную тильду:
~~старый вариант~~
Такое оформление удобно, например, чтобы показать изменившееся решение.
Маркированный список
Для маркированного списка перед каждым пунктом ставится дефис -.
Обычный список
Как написать:
- Первый пункт - Второй пункт - Третий пункт
Как будет отображаться:
- Первый пункт
- Второй пункт
- Третий пункт
Вложенный список
Чтобы сделать вложенный пункт, добавьте перед дефисом отступ.
Рекомендуется использовать два пробела на каждый следующий уровень вложенности.
Как написать:
- Документы - Справка - Счет - Акт - Отчеты - Продажи - Доходность
Как будет отображаться:
- Документы
** Справка ** Счет ** Акт
- Отчеты
** Продажи ** Доходность
Несколько уровней вложенности
Для каждого следующего уровня увеличивайте отступ.
Как написать:
- Разделы
- Документы
- Справка
- Счет
- Отчеты
- Продажи
- Доходность
- Настройки
- Пользователи
- Права доступа
Как будет отображаться:
- Разделы
** Документы *** Справка *** Счет ** Отчеты *** Продажи *** Доходность
- Настройки
** Пользователи ** Права доступа
Пример
Как написать:
- Проверить заявку - ФИО гостя - Даты проживания - Категорию номера - Рассчитать стоимость - Стоимость проживания - Стоимость лечения - Дополнительные услуги - Подтвердить заявку
Как будет отображаться:
- Проверить заявку
** ФИО гостя ** Даты проживания ** Категорию номера
- Рассчитать стоимость
** Стоимость проживания ** Стоимость лечения ** Дополнительные услуги
- Подтвердить заявку
Нумерованный список
Чтобы создать нумерованный список, перед каждым пунктом достаточно ставить 1..
Вручную указывать правильные номера не нужно — Markdown сам пронумерует пункты по порядку.
Как написать:
1. Первый шаг 1. Второй шаг 1. Третий шаг
Как будет отображаться:
- Первый шаг
- Второй шаг
- Третий шаг
Такой способ удобнее ручной нумерации. Если добавить новый пункт в середину списка, менять номера остальных пунктов не потребуется.
Пример изменения списка
Было:
1. Получить данные 1. Сформировать результат 1. Отправить результат
Добавили новый шаг:
1. Получить данные 1. Проверить данные 1. Сформировать результат 1. Отправить результат
В результате будет отображаться:
- Получить данные
- Проверить данные
- Сформировать результат
- Отправить результат
Вложенный нумерованный список
Как написать:
1. Подготовить данные 1. Проверить заполнение 1. Проверить даты 1. Выполнить расчет 1. Проверить результат
Как будет отображаться:
- Подготовить данные
- Проверить заполнение
- Проверить даты
- Выполнить расчет
- Проверить результат
Смешанный список
В нумерованный список можно вложить маркированный.
Как написать:
1. Проверить заявку - ФИО - Даты - Категорию номера 1. Рассчитать стоимость 1. Подтвердить заявку
Как будет отображаться:
- Проверить заявку
- ФИО
- Даты
- Категорию номера
- Рассчитать стоимость
- Подтвердить заявку
Список задач
Для небольших чек-листов:
- [x] Требования согласованы - [x] Разработка выполнена - [ ] Провести тестирование - [ ] Выпустить обновление
[x] означает выполненную задачу.
[ ] означает невыполненную задачу.
Цитата или важное замечание
Перед текстом поставьте символ >:
> Обратите внимание: после изменения настройки необходимо повторно открыть форму.
Можно использовать несколько строк:
> Важное замечание. > > Здесь можно дать более подробное пояснение.
Код внутри строки
Если нужно выделить имя функции, параметр, команду или небольшой фрагмент кода, используйте обратные кавычки:
Для получения значения используется функция `ПолучитьДанные()`.
Например:
`accessToken` `Истина` `Справочники.Контрагенты`
Блок кода
Большой фрагмент кода заключается между тройными обратными кавычками.
```
Сообщить("Привет!");
```
Можно указать язык программирования:
```bsl
Если ЗначениеЗаполнено(Контрагент) Тогда
Сообщить(Контрагент);
КонецЕсли;
```
Для JSON:
```json
{
"success": true,
"status": "ready"
}
```
Ссылки
Текст ссылки заключается в квадратные скобки, адрес — в круглые:
[Сайт Кинт](https://kint.ru)
Также можно просто указать адрес:
https://kint.ru
Таблицы
Таблица записывается так:
| Параметр | Значение | Описание | |---|---|---| | Статус | Активен | Текущий статус | | Количество | 10 | Количество записей | | Дата | 23.08.2026 | Дата изменения |
Первая строка содержит заголовки колонок.
Вторая строка отделяет заголовки от данных.
Выравнивание колонок
Можно задать выравнивание с помощью двоеточия:
| Наименование | Количество | Сумма | |:---|---:|---:| | Услуга 1 | 2 | 1 500 | | Услуга 2 | 1 | 750 |
:--- — выравнивание влево.
---: — выравнивание вправо.
:---: — выравнивание по центру.
Горизонтальная линия
Три дефиса создают разделитель:
---
Его удобно использовать между крупными частями текста.
Математические формулы
Формула внутри строки
Формула заключается в одинарные знаки $:
Площадь круга равна $S = \pi r^2$.
Другой пример:
$E = mc^2$
Или:
$x_1 + x_2 = -\frac{b}{a}$
Формула отдельным блоком
Для большой формулы используются двойные знаки $$:
$$
x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$
Такой вариант лучше использовать для сложных формул.
Дроби
$\frac{1}{2}$
$\frac{Сумма}{Количество}$
Степени и нижние индексы
$x^2$
$x_1$
$a_{12}$
$x^{10}$
Квадратный корень
$\sqrt{25}$
$\sqrt{x^2 + y^2}$
Математические символы
$\pi$ $\pm$ $\le$ $\ge$ $\neq$ $\infty$
Экранирование специальных символов
Некоторые символы имеют специальное значение:
* _ # $ `
Если символ нужно показать как обычный текст, перед ним можно поставить обратный слеш \:
\# Это не заголовок \*Это не курсив\* Цена составляет \$100.
Разметку можно комбинировать
Например:
## Результат обработки **Статус:** успешно Выполнены следующие действия: 1. Получены исходные данные. 1. Выполнена проверка. 1. Сформирован результат. > Обратите внимание: результат необходимо проверить перед публикацией. Основной параметр: `СтатусОбработки`. | Показатель | Значение | |---|---:| | Обработано | 125 | | Ошибок | 3 | - [x] Получить данные - [x] Выполнить обработку - [ ] Проверить ошибки