Перейти к содержанию

Markdown за 5 минут

Краткий справочник по разметке Markdown и расширениям, включённым на этом сайте. У каждого примера есть вкладка Код с исходной разметкой и вкладка Результат с тем, как это выглядит на странице.

Заголовки

От # до ###### — шесть уровней вложенности.

# Заголовок 1 уровня
## Заголовок 2 уровня
### Заголовок 3 уровня
#### Заголовок 4 уровня
##### Заголовок 5 уровня
###### Заголовок 6 уровня

Заголовок 4 уровня

Заголовок 5 уровня
Заголовок 6 уровня

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

**жирный текст**
*курсив*
***жирный курсив***
~~зачёркнутый текст~~
`встроенный код`
==выделенный текст==
текст^верхний индекс^
текст~нижний индекс~

жирный текст · курсив · жирный курсив · зачёркнутый текст · встроенный код · выделенный текст · текст^верхний индекс^ · текст~нижний индекс~

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

[Ссылка с текстом](https://alsinor.ru)
[Ссылка с подсказкой](https://alsinor.ru "Сайт alsinor.ru")

![Логотип завода](assets/images/logo_new.png)

Голые URL и упоминания превращаются в ссылки автоматически (расширение magiclink):

Документация лежит на https://wiki.alsinor.tech/

Документация лежит на https://wiki.alsinor.tech/

Списки

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

- Радиаторы
- Теплообменники
    - водомасляные
    - воздухо-воздушные
- Охладители наддувочного воздуха

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

1. Спроектировать
2. Изготовить
3. Испытать

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

  • Радиаторы
  • Теплообменники
    • водомасляные
    • воздухо-воздушные
  • Охладители наддувочного воздуха

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

  1. Спроектировать
  2. Изготовить
  3. Испытать

Список задач

- [x] Согласовать чертёж
- [x] Изготовить опытный образец
- [ ] Провести стендовые испытания
- [ ] Отгрузить заказчику
  • Согласовать чертёж
  • Изготовить опытный образец
  • Провести стендовые испытания
  • Отгрузить заказчику

Цитаты

> Радиатор — это теплообменный аппарат, служащий
> для охлаждения жидкости или газа набегающим потоком воздуха.
>
> > Вложенная цитата — например, примечание к цитате.

Радиатор — это теплообменный аппарат, служащий для охлаждения жидкости или газа набегающим потоком воздуха.

Вложенная цитата — например, примечание к цитате.

Блоки кода

Поддерживается подсветка синтаксиса, нумерация строк и якоря на конкретную строку.

```python linenums="1"
def cooling_efficiency(t_in: float, t_out: float, t_air: float) -> float:
    """КПД охлаждения радиатора."""
    return (t_in - t_out) / (t_in - t_air)
```
1
2
3
def cooling_efficiency(t_in: float, t_out: float, t_air: float) -> float:
    """КПД охлаждения радиатора."""
    return (t_in - t_out) / (t_in - t_air)

Таблицы

| Артикул              | Масса, кг | Теплоноситель |
|-----------------------|:---------:|---------------|
| 540-1013010-03         | 42        | вода          |
| 7548-1013160            | 68        | масло         |
Артикул Масса, кг Теплоноситель
540-1013010-03 42 вода
7548-1013160 68 масло

Горизонтальная черта

Текст до черты.

---

Текст после черты.

Текст до черты.


Текст после черты.

Сноски

Завод сертифицирован по ISO 9001[^1].

[^1]: Сертификат подтверждается ежегодным аудитом.

Завод сертифицирован по ISO 90011.

Списки определений

Радиатор
:   Теплообменный аппарат для охлаждения жидкости потоком воздуха.

Теплообменник
:   Устройство для передачи тепла между двумя теплоносителями.
Радиатор
Теплообменный аппарат для охлаждения жидкости потоком воздуха.
Теплообменник
Устройство для передачи тепла между двумя теплоносителями.

Атрибуты элементов

К почти любому элементу можно добавить класс, id или другой HTML-атрибут в фигурных скобках.

Обычный текст, а это { .md-typeset .md-typeset .md-button } похоже на кнопку.

[Похоже на кнопку](https://alsinor.ru){ .md-button .md-button--primary }

Комбинации клавиш

Сохранить документ: ++ctrl+s++

Прервать процесс: ++ctrl+alt+delete++

Сохранить документ: Ctrl+S

Прервать процесс: Ctrl+Alt+Del

Эмодзи и иконки

Полная подборка вынесена на отдельную страницу — Эмодзи и иконки.

Умные символы

(c) (r) (tm) 1/2 1/4 --> <-- <->

© ® ™ ½ ¼ → ← <->

Экранирование символов

Чтобы символ разметки отобразился как есть, поставьте перед ним обратный слэш.

\*не курсив\*, \# не заголовок, \`не код\`

*не курсив*, # не заголовок, `не код`

Переносы строк

Строка, после которой два пробела и перенос.  
Продолжение на новой строке той же строфы.

А это уже новый абзац — просто через пустую строку.

Строка, после которой два пробела и перенос.
Продолжение на новой строке той же строфы.

А это уже новый абзац — просто через пустую строку.

Врезки (admonitions)

!!! note "Примечание"

    Обычная врезка с заголовком по умолчанию.

!!! warning "Осторожно"

    Врезка с предупреждением.

??? tip "Сворачиваемая подсказка (нажмите, чтобы раскрыть)"

    Содержимое скрыто, пока пользователь не откроет блок.

Примечание

Обычная врезка с заголовком по умолчанию.

Осторожно

Врезка с предупреждением.

Сворачиваемая подсказка (нажмите, чтобы раскрыть)

Содержимое скрыто, пока пользователь не откроет блок.

Доступные типы врезок: note, abstract, info, tip, success, question, warning, failure, danger, bug, example, quote.

Вкладки с контентом

Именно ими оформлены все примеры на этой странице.

=== "Вкладка 1"

    Содержимое первой вкладки.

=== "Вкладка 2"

    Содержимое второй вкладки.

Содержимое первой вкладки.

Содержимое второй вкладки.


  1. Сертификат подтверждается ежегодным аудитом.