Перейти к содержимому

Форматирование

Примеры форматирования Markdown


Эта страница показывает, как писать контент в новой системе документации. Каждый пример сначала показывает результат, а сразу ниже — codeblock с исходным синтаксисом.

Заголовок H1

# Заголовок H1
# Заголовок H1

Заголовок H2

## Заголовок H2
## Заголовок H2

Заголовок H3

### Заголовок H3
### Заголовок H3

Заголовок H4

#### Заголовок H4
#### Заголовок H4
Заголовок H5
##### Заголовок H5
##### Заголовок H5
Заголовок H6
###### Заголовок H6
###### Заголовок H6

Жирный текст

Жирный текст

**Жирный текст**
**Жирный текст**

Курсивный текст

Курсивный текст

*Курсивный текст*
*Курсивный текст*

Зачёркнутый текст

Зачёркнутый текст

~~Зачёркнутый текст~~
~~Зачёркнутый текст~~

Подчёркнутый текст

Подчёркнутый текст
<u>Подчёркнутый текст</u>
<u>Подчёркнутый текст</u>

Выделенный текст

Выделенный текст зависит от accent color сайта.
<mark>Выделенный текст зависит от accent color сайта.</mark>
<mark>Выделенный текст зависит от accent color сайта.</mark>

Встроенный код

Используйте inline code внутри предложения.

Используйте `inline code` внутри предложения.
Используйте `inline code` внутри предложения.

Ссылки

Официальный сайт

[Официальный сайт](https://opensophy.com)
[Официальный сайт](https://opensophy.com)

Изображения

logo

![logo](/og-image.jpg)
![logo](/og-image.jpg)

Цитаты

Цитата использует акцентную линию сайта слева.

> Цитата использует акцентную линию сайта слева.
> Цитата использует акцентную линию сайта слева.

Маркированный список

  • Первый пункт
  • Второй пункт с жирным текстом
  • Третий пункт с inline code
- Первый пункт
- Второй пункт с **жирным** текстом
- Третий пункт с `inline code`
- Первый пункт
- Второй пункт с **жирным** текстом
- Третий пункт с `inline code`

Нумерованный список

  1. Первый шаг
  2. Второй шаг
  3. Третий шаг
1. Первый шаг
2. Второй шаг
3. Третий шаг
1. Первый шаг
2. Второй шаг
3. Третий шаг

Список задач

  • Завершённая задача
  • Незавершённая задача
  • Проверить вложенные markdown-компоненты
- [x] Завершённая задача
- [ ] Незавершённая задача
- [x] Проверить вложенные markdown-компоненты
- [x] Завершённая задача
- [ ] Незавершённая задача
- [x] Проверить вложенные markdown-компоненты

Блок уведомления: Примечание

Примечание
Полезная информация, которую нужно показать без агрессивного предупреждения.
<Admonition variant="note">
Полезная информация, которую нужно показать без агрессивного предупреждения.
</Admonition>
<Admonition variant="note">
Полезная информация, которую нужно показать без агрессивного предупреждения.
</Admonition>

Блок уведомления: Совет

Совет
Совет по лучшему использованию компонента или API.
<Admonition variant="tip">
Совет по лучшему использованию компонента или API.
</Admonition>
<Admonition variant="tip">
Совет по лучшему использованию компонента или API.
</Admonition>

Блок уведомления: Важно

Важно
Критичная информация, без которой инструкция может быть выполнена неправильно.
<Admonition variant="important">
Критичная информация, без которой инструкция может быть выполнена неправильно.
</Admonition>
<Admonition variant="important">
Критичная информация, без которой инструкция может быть выполнена неправильно.
</Admonition>

Блок уведомления: Предупреждение

Предупреждение
Предупреждение о возможной проблеме, несовместимости или ограничении.
<Admonition variant="warning">
Предупреждение о возможной проблеме, несовместимости или ограничении.
</Admonition>
<Admonition variant="warning">
Предупреждение о возможной проблеме, несовместимости или ограничении.
</Admonition>

Блок уведомления: Осторожно

Осторожно
Опасная операция, которая может сломать контент или состояние проекта.
<Admonition variant="caution">
Опасная операция, которая может сломать контент или состояние проекта.
</Admonition>
<Admonition variant="caution">
Опасная операция, которая может сломать контент или состояние проекта.
</Admonition>

Карточки

01
Component-first
Каждый паттерн живёт как Svelte-компонент с typed props.
02
Canvas-ready
Визуальные эффекты можно оборачивать в markdown-friendly блоки.
03
CLI workflow
Документация остаётся источником правды для install-flow.
<Cards>
  <Card eyebrow="01" title="Component-first">Каждый паттерн живёт как Svelte-компонент.</Card>
  <Card eyebrow="02" title="Canvas-ready">Визуальные эффекты можно оборачивать в markdown-friendly блоки.</Card>
  <Card eyebrow="03" title="CLI workflow">Документация остаётся источником правды.</Card>
</Cards>
<Cards>
  <Card eyebrow="01" title="Component-first">Каждый паттерн живёт как Svelte-компонент.</Card>
  <Card eyebrow="02" title="Canvas-ready">Визуальные эффекты можно оборачивать в markdown-friendly блоки.</Card>
  <Card eyebrow="03" title="CLI workflow">Документация остаётся источником правды.</Card>
</Cards>

Колонки

Левая колонка
Контент первой колонки.
Правая колонка
Контент второй колонки.
<Columns count={2}>
  <Card title="Левая колонка">Контент первой колонки.</Card>
  <Card title="Правая колонка">Контент второй колонки.</Card>
</Columns>
<Columns count={2}>
  <Card title="Левая колонка">Контент первой колонки.</Card>
  <Card title="Правая колонка">Контент второй колонки.</Card>
</Columns>

Шаги со статусами

Подготовить страницу

Страница создана и подключена к навигации.

Проверить оформление

Идёт проверка markdown-блоков.

Опубликовать

Следующий шаг после ревью.

Осторожно

Статус для потенциально опасного шага.
<Steps>
  <Step title="Подготовить страницу" status="done">Страница создана.</Step>
  <Step title="Проверить оформление" status="active">Идёт проверка.</Step>
  <Step title="Опубликовать" status="todo">Следующий шаг.</Step>
  <Step title="Осторожно" status="warning">Опасная операция.</Step>
</Steps>
<Steps>
  <Step title="Подготовить страницу" status="done">Страница создана.</Step>
  <Step title="Проверить оформление" status="active">Идёт проверка.</Step>
  <Step title="Опубликовать" status="todo">Следующий шаг.</Step>
  <Step title="Осторожно" status="warning">Опасная операция.</Step>
</Steps>

Таблица

Компонент Статус Комментарий
Table.svelte Готово Копирование, поиск, сортировка, fullscreen
Pre.svelte Готово Копирование и поиск по коду
Admonition.svelte Готово 5 типов уведомлений
| Компонент | Статус | Комментарий |
| --- | --- | --- |
| `Table.svelte` | Готово | Копирование, поиск, сортировка, fullscreen |
| `Pre.svelte` | Готово | Копирование и поиск по коду |
| `Admonition.svelte` | Готово | 5 типов уведомлений |
| Компонент | Статус | Комментарий |
| --- | --- | --- |
| `Table.svelte` | Готово | Копирование, поиск, сортировка, fullscreen |
| `Pre.svelte` | Готово | Копирование и поиск по коду |
| `Admonition.svelte` | Готово | 5 типов уведомлений |

Codeblock с поиском

export function example(title: string) {
  return `Документация: ${title}`;
}
export function example(title: string) {
  return `Документация: ${title}`;
}
```ts
export function example(title: string) {
  return `Документация: ${title}`;
}
```
```ts
export function example(title: string) {
  return `Документация: ${title}`;
}
```

KaTeX-формулы

Для формул рекомендуется использовать компонент <Katex> или markdown-синтаксис $...$ (инлайн) и $$...$$ (блочный).

Базовая формула (блочный режим)

E = mc^2
<Katex block>E = mc^2</Katex>
<Katex block>E = mc^2</Katex>

Инлайн-формула

Формула массы-энергии Эйнштейна E = mc^2 показывает эквивалентность массы и энергии.

Формула массы-энергии Эйнштейна <Katex>E = mc^2</Katex> показывает эквивалентность массы и энергии.
Формула массы-энергии Эйнштейна <Katex>E = mc^2</Katex> показывает эквивалентность массы и энергии.

Теорема Пифагора

a^2 + b^2 = c^2
<Katex block>a^2 + b^2 = c^2</Katex>
<Katex block>a^2 + b^2 = c^2</Katex>

Степенные формулы

x^2 + y^2 = r^2
<Katex block>x^2 + y^2 = r^2</Katex>
<Katex block>x^2 + y^2 = r^2</Katex>

Формулы с индексами

x_n = n^2
<Katex block>x_n = n^2</Katex>
<Katex block>x_n = n^2</Katex>
Примечание о сложных формулах
Для формул с LaTeX-командами, содержащими обратные слеши (например, `\frac`, `\int`, `\sum`), используйте markdown-синтаксис `$$...$$`, так как обратные слеши в Svelte-компонентах требуют особой обработки.

Графики

Графики задаются блоком :::chart: параметры в формате [имя]значение, данные — markdown-таблицей. Тип выбирается через [type], первая колонка — категории, остальные — числовые серии. Полный список параметров — на странице Основы и markdown.

Площадная диаграмма (area)

Посещаемость
:::chart
[type]area
[title]Посещаемость
[stack]stacked
[dots]border

| Месяц | Десктоп | Мобильные |
|-------|---------|-----------|
| Янв   | 342     | 245       |
| Фев   | 876     | 654       |
| Мар   | 512     | 387       |
| Апр   | 629     | 521       |
| Май   | 458     | 412       |
| Июн   | 781     | 598       |
:::
:::chart
[type]area
[title]Посещаемость
[stack]stacked
[dots]border

| Месяц | Десктоп | Мобильные |
|-------|---------|-----------|
| Янв   | 342     | 245       |
| Фев   | 876     | 654       |
| Мар   | 512     | 387       |
| Апр   | 629     | 521       |
| Май   | 458     | 412       |
| Июн   | 781     | 598       |
:::

Нормированная область ([stack]expanded) со штриховкой и фоном:

Доля трафика
:::chart
[type]area
[title]Доля трафика
[stack]expanded
[variant]hatched
[curve]natural
[background]dots

| Месяц | Поиск | Соцсети | Прямые |
|-------|-------|---------|--------|
| Янв   | 420   | 180     | 120    |
| Фев   | 380   | 260     | 140    |
| Мар   | 450   | 310     | 160    |
| Апр   | 400   | 350     | 210    |
| Май   | 520   | 290     | 230    |
:::
:::chart
[type]area
[title]Доля трафика
[stack]expanded
[variant]hatched
[curve]natural
[background]dots

| Месяц | Поиск | Соцсети | Прямые |
|-------|-------|---------|--------|
| Янв   | 420   | 180     | 120    |
| Фев   | 380   | 260     | 140    |
| Мар   | 450   | 310     | 160    |
| Апр   | 400   | 350     | 210    |
| Май   | 520   | 290     | 230    |
:::

Линейный график (line)

Рост подписчиков
:::chart
[type]line
[title]Рост подписчиков
[curve]monotone
[glow]true

| Месяц | Instagram | Telegram | YouTube |
|-------|-----------|----------|---------|
| Янв   | 2100      | 1400     | 900     |
| Фев   | 2400      | 1650     | 1050    |
| Мар   | 2900      | 1900     | 1300    |
| Апр   | 3300      | 2200     | 1500    |
| Май   | 3800      | 2500     | 1750    |
| Июн   | 4200      | 2800     | 2000    |
:::
:::chart
[type]line
[title]Рост подписчиков
[curve]monotone
[glow]true

| Месяц | Instagram | Telegram | YouTube |
|-------|-----------|----------|---------|
| Янв   | 2100      | 1400     | 900     |
| Фев   | 2400      | 1650     | 1050    |
| Мар   | 2900      | 1900     | 1300    |
| Апр   | 3300      | 2200     | 1500    |
| Май   | 3800      | 2500     | 1750    |
| Июн   | 4200      | 2800     | 2000    |
:::

Ступенчатая линия ([curve]step) с точками и выбором диапазона ([brush]):

Активные серверы
Пн
Вс
:::chart
[type]line
[title]Активные серверы
[curve]step
[dots]colored-border
[stroke]dashed
[brush]true
[yAxis]true

| День | Прод | Стейдж |
|------|------|--------|
| Пн   | 12   | 4      |
| Вт   | 14   | 5      |
| Ср   | 14   | 3      |
| Чт   | 17   | 6      |
| Пт   | 16   | 6      |
| Сб   | 11   | 2      |
| Вс   | 10   | 2      |
:::
:::chart
[type]line
[title]Активные серверы
[curve]step
[dots]colored-border
[stroke]dashed
[brush]true
[yAxis]true

| День | Прод | Стейдж |
|------|------|--------|
| Пн   | 12   | 4      |
| Вт   | 14   | 5      |
| Ср   | 14   | 3      |
| Чт   | 17   | 6      |
| Пт   | 16   | 6      |
| Сб   | 11   | 2      |
| Вс   | 10   | 2      |
:::

Столбчатая диаграмма (bar)

Продажи по кварталам
:::chart
[type]bar
[title]Продажи по кварталам
[variant]duotone

| Квартал | Продукт А | Продукт Б |
|---------|-----------|-----------|
| Q1      | 4200      | 3100      |
| Q2      | 5800      | 4700      |
| Q3      | 5200      | 5400      |
| Q4      | 7100      | 6200      |
:::
:::chart
[type]bar
[title]Продажи по кварталам
[variant]duotone

| Квартал | Продукт А | Продукт Б |
|---------|-----------|-----------|
| Q1      | 4200      | 3100      |
| Q2      | 5800      | 4700      |
| Q3      | 5200      | 5400      |
| Q4      | 7100      | 6200      |
:::

Горизонтальные столбцы с накоплением ([layout]horizontal, [stack]stacked):

Задачи по командам
:::chart
[type]bar
[title]Задачи по командам
[layout]horizontal
[stack]stacked
[variant]hatched
[legend-variant]rounded-square

| Команда  | Готово | В работе | Бэклог |
|----------|--------|----------|--------|
| Backend  | 42     | 12       | 8      |
| Frontend | 35     | 15       | 11     |
| Mobile   | 21     | 9        | 14     |
| DevOps   | 18     | 6        | 4      |
:::
:::chart
[type]bar
[title]Задачи по командам
[layout]horizontal
[stack]stacked
[variant]hatched
[legend-variant]rounded-square

| Команда  | Готово | В работе | Бэклог |
|----------|--------|----------|--------|
| Backend  | 42     | 12       | 8      |
| Frontend | 35     | 15       | 11     |
| Mobile   | 21     | 9        | 14     |
| DevOps   | 18     | 6        | 4      |
:::

Столбцы в процентах ([stack]percent) с подсветкой при наведении:

Структура выручки
:::chart
[type]bar
[title]Структура выручки
[stack]percent
[highlight]true

| Квартал | Подписки | Услуги | Разовые |
|---------|----------|--------|---------|
| Q1      | 52       | 30     | 18      |
| Q2      | 58       | 27     | 15      |
| Q3      | 61       | 26     | 13      |
| Q4      | 66       | 22     | 12      |
:::
:::chart
[type]bar
[title]Структура выручки
[stack]percent
[highlight]true

| Квартал | Подписки | Услуги | Разовые |
|---------|----------|--------|---------|
| Q1      | 52       | 30     | 18      |
| Q2      | 58       | 27     | 15      |
| Q3      | 61       | 26     | 13      |
| Q4      | 66       | 22     | 12      |
:::

Комбинированный график (composed)

Выручка и прибыль
:::chart
[type]composed
[title]Выручка и прибыль
[variant]gradient
[lines]Прибыль

| Месяц | Выручка | Прибыль |
|-------|---------|---------|
| Янв   | 8200    | 1400    |
| Фев   | 9100    | 1700    |
| Мар   | 10500   | 2100    |
| Апр   | 9800    | 1900    |
| Май   | 11200   | 2500    |
| Июн   | 12400   | 2900    |
:::
:::chart
[type]composed
[title]Выручка и прибыль
[variant]gradient
[lines]Прибыль

| Месяц | Выручка | Прибыль |
|-------|---------|---------|
| Янв   | 8200    | 1400    |
| Фев   | 9100    | 1700    |
| Мар   | 10500   | 2100    |
| Апр   | 9800    | 1900    |
| Май   | 11200   | 2500    |
| Июн   | 12400   | 2900    |
:::

Круговая и кольцевая диаграммы (pie / donut)

Распределение бюджета
:::chart
[type]donut
[title]Распределение бюджета

| Статья         | Сумма |
|----------------|-------|
| Разработка     | 45    |
| Маркетинг      | 25    |
| Инфраструктура | 20    |
| Прочее         | 10    |
:::
:::chart
[type]donut
[title]Распределение бюджета

| Статья         | Сумма |
|----------------|-------|
| Разработка     | 45    |
| Маркетинг      | 25    |
| Инфраструктура | 20    |
| Прочее         | 10    |
:::

Круговая диаграмма ([type]pie):

Браузеры
:::chart
[type]pie
[title]Браузеры

| Браузер | Посетители |
|---------|------------|
| Chrome  | 275        |
| Safari  | 200        |
| Firefox | 187        |
| Edge    | 173        |
| Другие  | 90         |
:::
:::chart
[type]pie
[title]Браузеры

| Браузер | Посетители |
|---------|------------|
| Chrome  | 275        |
| Safari  | 200        |
| Firefox | 187        |
| Edge    | 173        |
| Другие  | 90         |
:::

Радарная диаграмма (radar)

Оценка компетенций
:::chart
[type]radar
[title]Оценка компетенций
[dots]border

| Навык        | Разработчик | Дизайнер |
|--------------|-------------|----------|
| Технический  | 9           | 5        |
| Коммуникации | 7           | 8        |
| Аналитика    | 8           | 7        |
| Творчество   | 6           | 9        |
| Управление   | 6           | 5        |
:::
:::chart
[type]radar
[title]Оценка компетенций
[dots]border

| Навык        | Разработчик | Дизайнер |
|--------------|-------------|----------|
| Технический  | 9           | 5        |
| Коммуникации | 7           | 8        |
| Аналитика    | 8           | 7        |
| Творчество   | 6           | 9        |
| Управление   | 6           | 5        |
:::

Только контуры ([variant]lines) и круговая сетка ([grid]circle):

Сравнение тарифов
:::chart
[type]radar
[title]Сравнение тарифов
[variant]lines
[grid]circle
[legend-variant]circle

| Параметр   | Базовый | Про |
|------------|---------|-----|
| Скорость   | 60      | 95  |
| Хранилище  | 40      | 90  |
| Поддержка  | 50      | 85  |
| Интеграции | 30      | 80  |
| Цена       | 90      | 55  |
:::
:::chart
[type]radar
[title]Сравнение тарифов
[variant]lines
[grid]circle
[legend-variant]circle

| Параметр   | Базовый | Про |
|------------|---------|-----|
| Скорость   | 60      | 95  |
| Хранилище  | 40      | 90  |
| Поддержка  | 50      | 85  |
| Интеграции | 30      | 80  |
| Цена       | 90      | 55  |
:::

Радиальная диаграмма (radial)

Выполнение плана
:::chart
[type]radial
[title]Выполнение плана
[max]100

| Команда  | Процент |
|----------|---------|
| Backend  | 82      |
| Frontend | 64      |
| Mobile   | 47      |
:::
:::chart
[type]radial
[title]Выполнение плана
[max]100

| Команда  | Процент |
|----------|---------|
| Backend  | 82      |
| Frontend | 64      |
| Mobile   | 47      |
:::

Полукруг ([variant]semi):

Загрузка ресурсов
:::chart
[type]radial
[title]Загрузка ресурсов
[variant]semi
[max]100

| Ресурс | Процент |
|--------|---------|
| CPU    | 72      |
| RAM    | 58      |
| Диск   | 34      |
:::
:::chart
[type]radial
[title]Загрузка ресурсов
[variant]semi
[max]100

| Ресурс | Процент |
|--------|---------|
| CPU    | 72      |
| RAM    | 58      |
| Диск   | 34      |
:::

Диаграмма Санки (sankey)

Воронка продаж
:::chart
[type]sankey
[title]Воронка продаж
[values]true

| Откуда  | Куда    | Пользователи |
|---------|---------|--------------|
| Поиск   | Лендинг | 42000        |
| Реклама | Лендинг | 28000        |
| Лендинг | Товар   | 52000        |
| Лендинг | Отказ   | 18000        |
| Товар   | Покупка | 24000        |
| Товар   | Отказ   | 28000        |
:::
:::chart
[type]sankey
[title]Воронка продаж
[values]true

| Откуда  | Куда    | Пользователи |
|---------|---------|--------------|
| Поиск   | Лендинг | 42000        |
| Реклама | Лендинг | 28000        |
| Лендинг | Товар   | 52000        |
| Лендинг | Отказ   | 18000        |
| Товар   | Покупка | 24000        |
| Товар   | Отказ   | 28000        |
:::

Связи цветом источника и подписи внутри узлов ([variant]source, [labels]inside):

Распределение бюджета
:::chart
[type]sankey
[title]Распределение бюджета
[variant]source
[labels]inside
[nodeWidth]80

| Откуда    | Куда       | Сумма |
|-----------|------------|-------|
| Бюджет    | Разработка | 45    |
| Бюджет    | Маркетинг  | 25    |
| Бюджет    | Сервера    | 20    |
| Разработка| Зарплаты   | 38    |
| Разработка| Сервисы    | 7     |
:::
:::chart
[type]sankey
[title]Распределение бюджета
[variant]source
[labels]inside
[nodeWidth]80

| Откуда    | Куда       | Сумма |
|-----------|------------|-------|
| Бюджет    | Разработка | 45    |
| Бюджет    | Маркетинг  | 25    |
| Бюджет    | Сервера    | 20    |
| Разработка| Зарплаты   | 38    |
| Разработка| Сервисы    | 7     |
:::

Цвета

[colors] задаёт цвета серий через запятую: #hex для обеих тем, #светлая|#тёмная для каждой темы отдельно и #a>#b для градиента.

Свои цвета
:::chart
[type]area
[title]Свои цвета
[curve]bump
[stroke]solid
[colors]#7c3aed>#0891b2|#a78bfa>#22d3ee, #ea580c|#fbbf24

| Месяц | Подписки | Отписки |
|-------|----------|---------|
| Янв   | 120      | 40      |
| Май   | 210      | 45      |
:::
:::chart
[type]area
[title]Свои цвета
[curve]bump
[stroke]solid
[colors]#7c3aed>#0891b2|#a78bfa>#22d3ee, #ea580c|#fbbf24

| Месяц | Подписки | Отписки |
|-------|----------|---------|
| Янв   | 120      | 40      |
| Май   | 210      | 45      |
:::

FAQ аккордеон

Компонент Faq отображает раскрывающийся список вопросов и ответов с плавной анимацией.

<script>
	import Faq from '$lib/components/ui-registry/Faq.svelte';
</script>

<Faq />
<script>
	import Faq from '$lib/components/ui-registry/Faq.svelte';
</script>

<Faq />

Кастомные вопросы

<Faq
	items={[
		{ question: 'Что это?', answer: 'Это шаблонный ответ на ваш вопрос.' },
		{ question: 'Как начать?', answer: 'Следуйте руководству по быстрому старту.' }
	]}
/>
<Faq
	items={[
		{ question: 'Что это?', answer: 'Это шаблонный ответ на ваш вопрос.' },
		{ question: 'Как начать?', answer: 'Следуйте руководству по быстрому старту.' }
	]}
/>