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

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

Примеры форматирования 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. Тип указывается через [type].

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

Рост подписчиков
01k3k4k5kЯнвФевМарАпрМайИюн
:::chart
[title]Рост подписчиков
[type]line

| Месяц | Instagram | Telegram | YouTube |
|-------|-----------|----------|---------|
| Янв   | 2100      | 1400     | 900     |
| Июн   | 4200      | 2800     | 2000    |
:::
:::chart
[title]Рост подписчиков
[type]line

| Месяц | Instagram | Telegram | YouTube |
|-------|-----------|----------|---------|
| Янв   | 2100      | 1400     | 900     |
| Июн   | 4200      | 2800     | 2000    |
:::

Столбчатый график (bar)

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

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

| Квартал | Продукт А | Продукт Б |
|---------|-----------|-----------|
| Q1      | 4200      | 3100      |
| Q4      | 7100      | 6200      |
:::

Составной график (composed)

Выручка и прибыль
05k10k15k20kЯнвФевМарАпрМайИюн
:::chart
[title]Выручка и прибыль
[type]composed

| Месяц | Выручка | Прибыль |
|-------|---------|---------|
| Янв   | 8200    | 1400    |
| Июн   | 12400   | 2900    |
:::
:::chart
[title]Выручка и прибыль
[type]composed

| Месяц | Выручка | Прибыль |
|-------|---------|---------|
| Янв   | 8200    | 1400    |
| Июн   | 12400   | 2900    |
:::

Диаграмма рассеяния (scatter)

Корреляция цена / рейтинг
0150300450600Товар АТовар БТовар ВТовар ГТовар ДТовар Е
:::chart
[title]Корреляция цена / рейтинг
[type]scatter

| Товар   | Цена | Рейтинг |
|---------|------|---------|
| Товар А | 120  | 4.2     |
| Товар Г | 560  | 4.9     |
:::
:::chart
[title]Корреляция цена / рейтинг
[type]scatter

| Товар   | Цена | Рейтинг |
|---------|------|---------|
| Товар А | 120  | 4.2     |
| Товар Г | 560  | 4.9     |
:::

Круговая диаграмма (pie)

Источники трафика
42281812
:::chart
[title]Источники трафика
[type]pie

| Источник     | Доля |
|--------------|------|
| Органический | 42   |
| Реклама      | 28   |
:::
:::chart
[title]Источники трафика
[type]pie

| Источник     | Доля |
|--------------|------|
| Органический | 42   |
| Реклама      | 28   |
:::

Кольцевая диаграмма (ring)

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

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

| Статья     | Сумма |
|------------|-------|
| Разработка | 45    |
| Маркетинг  | 25    |
:::

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

Оценка компетенций
ТехническийКоммуникацииАналитикаТворчествоУправление
:::chart
[title]Оценка компетенций
[type]radar

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

| Навык        | Разработчик | Дизайнер |
|--------------|-------------|----------|
| Технический  | 9           | 5        |
| Творчество   | 6           | 9        |
:::