Полный гид по оформлению текста

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

1. Базовое форматирование

• Жирный текст для акцентов.
• Курсив для терминов.
• Зачеркнутый текст, если что-то неактуально.
• Моноширинный шрифт для кода или клавиш.

2. Цветовые выделения и кастомные стили

Поскольку мы используем Astro, мы можем вставлять HTML прямо в Markdown для тонкой настройки.

• Красный жирный текст
• Зеленый текст для успеха
• Текст с закругленным фоном
• Текст с пунктирным подчеркиванием

3. Сноски (Footnotes)

Сноски очень удобны для пояснений, которые не должны прерывать чтение основного текста.

Вот пример текста со сноской¹. А вот еще одна сноска для закрепления материала².

4. Информационные вставки (Admonitions)

Для важных объявлений лучше использовать блоки с фоном.

💡 Совет > Используй стандартные цитаты Markdown для создания простых заметок. Они будут выглядеть стильно благодаря нашим глобальным стилям.

5. Списки и таблицы

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

• Пункт А
• Пункт Б
  • Вложенный пункт

Таблица возможностей:

6. Код с подсветкой

Astro автоматически подсвечивает синтаксис (через Shiki):

function helloWorld(name: string): string {
  return `Привет, ${name}!`;
}

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

Для системных уведомлений используйте блоки:

Работа со сносками

Иногда нужно добавить уточнение, не перегружая абзац. Для этого идеально подходят сноски¹.

Таблицы данных

Таблицы теперь имеют четкие границы и легкий фон заголовков для лучшего сканирования взглядом.