Markdown: синтаксис и рендеринг

Заголовки

# Заголовок 1
## Заголовок 2
### Заголовок 3

Чем больше решёток, тем меньше заголовок.

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

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

Результат: жирный текст, курсив, зачёркнутый, код в строке

Списки

Ненумерованный:

- первый пункт
- второй пункт
- третий пункт

Нумерованный:

1. первый пункт
2. второй пункт
3. третий пункт

Ссылки

Обычная ссылка:

[текст ссылки](https://example.com)

Wikilink (ссылка на другую заметку):

[[Название заметки]]

Wikilinks — главная фишка Obsidian. Подробнее: Obsidian и связи между заметками

Изображения

![описание картинки](путь/к/картинке.png)

Можно вставлять картинки из папки с заметками или по URL.

Цитаты

> Это цитата.
> Может быть многострочной.

Результат:

Это цитата.
Может быть многострочной.

Каллауты

Каллаут — это цитата, первая строка которой содержит маркер [!тип]. trip2g рендерит её как стилизованный блок с иконкой и заголовком.

Базовый каллаут — имя типа становится заголовком:

> [!note]
> Содержимое каллаута.

Произвольный заголовок — укажите текст после типа:

> [!info] Начало работы
> Этот заголовок заменяет стандартный.

Сворачиваемый (свёрнут по умолчанию) — читатель нажимает, чтобы раскрыть:

> [!tip]- Как свернуть каллаут
> Добавьте `-` после типа, чтобы блок был свёрнут по умолчанию.

Сворачиваемый (развёрнут по умолчанию) — можно свернуть:

> [!faq]+ Этот блок открыт сразу?
> Да. `+` означает, что блок раскрыт по умолчанию.

Встроенные типы с отдельными иконками: note, abstract, summary, tldr, info, todo, tip, hint, important, success, check, done, question, help, faq, warning, caution, attention, failure, fail, missing, danger, error, bug, example, quote, cite. Произвольные типы тоже допустимы — они рендерятся с резервной иконкой.

Комментарии

Текст, обёрнутый в %%, является комментарием Obsidian и удаляется из результата рендеринга.

Строчный комментарий — удаляется между окружающим текстом:

Текст ДО%%этот текст скрыт%%ПОСЛЕ виден.

Блочный комментарий — отдельная строка %% открывает комментарий, вторая закрывает его. Всё содержимое между ними скрыто:

%%
Этот блок полностью удаляется со страницы.
Скрыто несколько строк.
%%

Буквальный текст %% внутри блоков кода и строчного кода сохраняется без изменений.

Код

Блок кода с подсветкой синтаксиса:

```javascript
function hello() {
  console.log("Hello, world!");
}
```

Укажите язык после первых трёх обратных кавычек для подсветки.

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

---

Три дефиса создают разделитель.

Таблицы

| Колонка 1 | Колонка 2 |
|-----------|-----------|
| Ячейка 1  | Ячейка 2  |
| Ячейка 3  | Ячейка 4  |

Результат:

Чекбоксы

- [ ] незавершённая задача
- [x] завершённая задача

Frontmatter

В начале файла можно добавить метаданные в формате YAML:

---
title: "Название заметки"
free: true
---

Текст заметки начинается после второго ---

Frontmatter используется для настройки публикации в trip2g. Подробнее: Свойства заметок

Видео

Встройте видеофайл из хранилища через ![[...]]:

![[demo.mp4]]

Поддерживаемые форматы: .mp4, .avi, .mov, .mkv, .webm, .m4v. Файл рендерится как <video>-плеер с элементами управления.

Аудио

Встройте аудиофайл так же:

![[запись.mp3]]

Поддерживаемые форматы: .mp3, .wav, .ogg, .flac, .m4a, .aac. Файл рендерится как <audio>-плеер с элементами управления — читатель может воспроизводить, ставить на паузу и перематывать без перехода на другую страницу.

Синтаксис изображений Markdown тоже запускает аудиоплеер для аудиофайлов:

![](запись.mp3)

Документы (ссылки для скачивания)

Если встроить документ через ![[...]], trip2g рендерит его как ссылку для скачивания, а не пытается отобразить содержимое:

![[отчёт.pdf]]
![[данные.xlsx]]

Поддерживаются как ссылки для скачивания: .pdf, .doc, .docx, .xls, .xlsx, .ppt, .pptx, .txt, .rtf, .odt, .ods, .odp, .csv, .zip, .rar, .7z.

Ссылка показывает имя файла и скачивает файл при клике.

Особенности рендеринга

Смотрите также

• ru/user/Свойства заметок — свойства frontmatter, управление доступом, URL-настройки
• ru/user/mermaid — блоки диаграмм Mermaid
• ru/user/youtube_embed — синтаксис встраивания YouTube
• Типографика и Markdown — полная демо-страница рендеринга