Синтаксис Markdown

Это руководство для авторов объясняет инструменты подготовки материалов сайта; оно не является энциклопедической статьёй о тюркской культуре.

Заголовки

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

## Заголовки

Подзаголовки

Используйте подзаголовки для дальнейшего деления разделов. Они создают более детальную иерархию содержимого для лучшей читаемости.

### Подзаголовки

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

Nuxt UI поддерживает большинство параметров форматирования Markdown.

Комбинируйте форматирование для создания более богатых стилей текста.

Для степеней, индексов или математических обозначений используйте HTML-теги <sup> и <sub>.

Ссылки

Ссылки соединяют различные части документации и внешние ресурсы, необходимы для навигации пользователей. Чтобы создать ссылку, заключите текст ссылки в скобки []().

[Nuxt UI](https://ui.nuxt.com/getting-started/installation)

Внутренние ссылки

Для ссылок внутри документации используйте пути с префиксом языка, например /ru/docs/essentials/markdown-syntax.

[Установка](/ru/docs/essentials/markdown-syntax)

Списки

Организуйте связанные элементы в структурированном, удобочитаемом формате. Markdown поддерживает неупорядоченные, упорядоченные и вложенные списки.

Неупорядоченный

Используйте неупорядоченные списки для элементов без определённой последовательности. Начинайте каждый элемент с символа -.

- Я элемент списка.
- Я ещё один элемент списка.
- Я последний элемент списка.

Упорядоченный

Используйте упорядоченные списки, когда важен порядок элементов, например в пошаговых инструкциях. Начинайте каждый элемент с числа.

1. Я элемент списка.
2. Я ещё один элемент списка.
3. Я последний элемент списка.

Вложенный

Создавайте иерархические списки с вложенными элементами для сложных структур. Отступ вложенных элементов — четыре пробела.

- Я элемент списка.
  - Я вложенный элемент списка.
  - Я ещё один вложенный элемент.
- Я ещё один элемент списка.

Таблицы

Представляйте структурированные данные в строках и столбцах. Таблицы идеально подходят для сравнения данных или перечисления свойств.

| Prop    | Default   | Type                     |
|---------|-----------|--------------------------|
| `name`  |           | `string`{lang="ts-type"} |
| `size`  | `md`      | `string`{lang="ts-type"} |
| `color` | `neutral` | `string`{lang="ts-type"} |

Блок-цитаты

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

Однострочная

Однострочные блок-цитаты лучше всего подходят для коротких, ёмких цитат. Чтобы создать блок-цитату, добавьте > перед абзацем.

> Nuxt UI — это коллекция Vue-компонентов, composables и утилит для создания красивых и доступных пользовательских интерфейсов.

Многострочная

Многострочные блок-цитаты подходят для длинных цитат или когда необходимо включить несколько абзацев в одну цитату.

> Nuxt UI — это коллекция Vue-компонентов, composables и утилит для создания красивых и доступных пользовательских интерфейсов.
>
> Создавайте красивые, адаптивные и доступные Vue-приложения с Nuxt UI.