Markdown

Markdown — способ форматировать текст обычными символами. Каждая заметка в trip2g — это .md-файл. Он открывается в Obsidian, VS Code, Блокноте или любом текстовом редакторе. Ни одно приложение не владеет этим форматом.

Коротко

Markdown использует # для заголовков, ** для полужирного, * для курсива, - для списков и тройные обратные кавычки для блоков кода. Вики-ссылки ([[Название заметки]]) — расширение Obsidian для связей между заметками. Frontmatter — блок YAML между маркерами --- в начале файла — управляет тем, как trip2g публикует заметку: URL, видимость, место в навигации.

Заголовки

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

Один # — для названия страницы. Подразделы получают ## и ###. Если структура уходит глубже трёх уровней — обычно это сигнал разбить материал на отдельные заметки.

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

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

Ссылки

Стандартная ссылка Markdown:

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

Вики-ссылки

Вики-ссылки — расширение стандартного Markdown, введённое Obsidian и поддерживаемое trip2g нативно. Они не входят в спецификацию Markdown — это соглашение для связей между заметками внутри хранилища.

[[Название заметки]]
[[Название заметки|Текст ссылки]]

Текст внутри [[ и ]] — имя файла целевой заметки без .md. Путь указывать не нужно — trip2g находит файл в любом месте хранилища.

Обратные ссылки. Когда заметка А ссылается на заметку Б, заметка Б автоматически знает об этом. Откройте любую заметку — увидите все заметки, которые на неё ссылаются. Связи, которые вы не планировали, становятся видимыми.

Встраивание. Добавьте ! перед ссылкой, чтобы встроить заметку или изображение прямо в текст:

![[изображение.png]]
![[Другая заметка]]

В стандартном Markdown нет обратных ссылок и разрешения путей по хранилищу. Именно этот пробел заполняют вики-ссылки.

Списки

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

- Первый пункт
- Второй пункт
  - Вложенный пункт

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

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

Список задач:

- [ ] Сделать
- [x] Готово

Изображения

Стандартный синтаксис Markdown:

![альтернативный текст](путь/к/файлу.png)

Вставка в стиле Obsidian (рекомендуется в хранилищах Obsidian):

![[изображение.png]]

Оба варианта работают в trip2g. Вставка в стиле Obsidian находит файл в любом месте хранилища без указания пути.

Код

Код в строке — одиночные обратные кавычки:

Выполните `npm install` для установки зависимостей.

Блок кода с опциональным указанием языка для подсветки синтаксиса:

```javascript
function greet(name) {
  return `Привет, ${name}`;
}
```

Цитаты

> Это блок цитаты.
> Он может занимать несколько строк.

Таблицы

| Столбец А | Столбец Б | Столбец В |
| --------- | :-------: | --------: |
| слева     |  по центру | справа   |
| выравнено | выравнено | выравнено |

Двоеточия в строке-разделителе задают выравнивание: левое (по умолчанию), центральное (:---:), правое (---:).

Frontmatter

Frontmatter — блок YAML в самом начале Markdown-файла, ограниченный маркерами ---:

---
title: "Моя заметка"
free: true
---

Всё между двумя строками --- — метаданные. В видимом содержимом страницы они не отображаются. trip2g читает этот блок, чтобы знать, как публиковать заметку.

Поля frontmatter, которые распознаёт trip2g:

Поле	Назначение
title	Заголовок страницы во вкладке браузера и навигации сайта
slug	Переопределение URL — например, slug: /docs/intro
free: true	Делает заметку публично доступной без подписки
home_position	Порядок сортировки на страницах-индексах в стиле журнала
lang_redirect	Ссылка на эквивалентную страницу на другом языке

Если поле free отсутствует, заметка по умолчанию доступна только подписчикам. Если slug не указан, trip2g формирует URL из пути к файлу.

Подробнее

Полная шпаргалка по Markdown — learnxinyminutes.com