Расширенные функции Markdown

3 min

Здесь представлены некоторые расширенные функции Markdown, поддерживаемые темой Retypeset, включая примеры синтаксиса и их стилистические эффекты.

Подписи к изображениям

Для создания автоматических подписей к изображениям используйте стандартный синтаксис изображений Markdown ![alt](src). Чтобы скрыть подпись, добавьте подчёркивание _ перед текстом alt или оставьте текст alt пустым.

Синтаксис

![Описание изображения](./full/or/relative/path/of/image)

![_Описание изображения](./full/or/relative/path/of/image)

Результат

Описание изображения
Описание изображения

_Описание изображения

Карточки репозиториев Github

Для создания карточки репозитория Github используйте синтаксис с двойным двоеточием ::github{repo="owner/repo"}. Данные репозитория загружаются из API GitHub после загрузки страницы.

Синтаксис

::github{repo="radishzzz/astro-theme-retypeset"}

Результат

radishzzzastro-theme-retypeset

Loading repository data...

-- -- --

Примечания

Для создания блоков примечаний используйте синтаксис GitHub > [!TYPE] или синтаксис с тройным двоеточием :::type. Поддерживаются пять типов: note, tip, important, warning и caution.

Синтаксис

> [!NOTE]
> Полезная информация, которую пользователи должны знать, даже при беглом просмотре.

:::note
Полезная информация, которую пользователи должны знать, даже при беглом просмотре.
:::

:::note[ПОЛЬЗОВАТЕЛЬСКИЙ ЗАГОЛОВОК]
Это примечание с пользовательским заголовком.
:::

Результат

NOTE

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

TIP

Полезные советы, как делать что-то лучше или проще.

IMPORTANT

Ключевая информация, которую пользователи должны знать для достижения своей цели.

WARNING

Срочная информация, требующая немедленного внимания пользователя для предотвращения проблем.

CAUTION

Предупреждает о рисках или негативных последствиях определённых действий.

ПОЛЬЗОВАТЕЛЬСКИЙ ЗАГОЛОВОК

Это примечание с пользовательским заголовком.