> For AI agents: the complete documentation index is available at /rspress-russian/llms.txt, the full documentation bundle is available at /rspress-russian/llms-full.txt.

# MDX и React-компоненты

Rspress поддерживает [MDX](https://mdxjs.com/), формат создания контента, который бесшовно объединяет Markdown с JSX. MDX позволяет использовать компоненты React напрямую в вашей документации, сочетая лаконичный синтаксис Markdown с экосистемой React. Он идеально подходит для создания интерактивной, компонентно-ориентированной технической документации.

## Что такое MDX

MDX объединяет синтаксис Markdown и JSX, поэтому вы можете писать контент Markdown и использовать компоненты React в одном файле.

Мы рекомендуем использовать `.mdx` для всех файлов документации. Это позволяет использовать в качестве контента обычный Markdown, но при этом импортировать и использовать [встроенные компоненты](/rspress-russian/ui/components/index.md), предоставляемые Rspress.

```mdx title="docs/index.mdx"
# Привет, мир!

import { PackageManagerTabs } from '@rspress/core/theme';

<PackageManagerTabs command="create rspress@latest" />
```

## Фрагменты MDX \{#fragments}

Каждый файл `.mdx` компилируется в React-компонент, что означает, что его можно импортировать как обычный компонент и свободно рендерить внутри него React-компоненты. Например:


**docs/index.mdx**

```mdx
import MdxFragment from './_mdx-fragment.mdx';
import TsxComponent from './_tsx-component';

Тестирование использования MDX-фрагментов и React-компонентов.

<MdxFragment />

<TsxComponent />
```


**docs/_mdx-fragment.mdx**

```mdx file="./_mdx-fragment.mdx"
Это **фрагмент mdx**.

```


**docs/_tsx-component.tsx**

```tsx file="./_tsx-component.tsx"
import { useState } from 'react';

export default () => {
  const [count, setCount] = useState(0);
  return (
    <p>
      Это компонент из tsx{' '}
      <button onClick={() => setCount(count => count + 1)}>{count}</button>
    </p>
  );
};

```


Это отображается как:


Тестирование использования MDX-фрагментов и React-компонентов.
Это **фрагмент mdx**.

Это компонент из tsx 0


В файлах `.mdx` вы можете использовать [встроенные компоненты](/rspress-russian/ui/components/index.md), предоставляемые Rspress, или устанавливать библиотеки компонентов React, чтобы обогатить вашу документацию.

## Соглашение о маршрутах \{#routing-convention}

В [директории документации](/rspress-russian/api/config/config-basic.md#root) MDX-фрагменты или React-компоненты должны быть исключены из маршрутизации с помощью [route.exclude](/rspress-russian/api/config/config-basic.md#routeexclude). Для удобства файлы, начинающиеся с `_`, исключаются по умолчанию через [route.excludeConvention](/rspress-russian/api/config/config-basic.md#routeexcludeconvention).

Также вы можете размещать компоненты в соседних директориях вне директории docs. Например:

```text
docs
├── _button.mdx
└── index.mdx
components
└── button.tsx
```


**docs/index.mdx**

```mdx
import ButtonFragment from './_button.mdx';
import Button from '../../components/button';

<ButtonFragment />
<Button />
```


**docs/_button.mdx**

```mdx file="./_button.mdx"
#### кнопка

Текст из MDX
```


**docsite/components/button.tsx**

```tsx
const Button = () => <button>Кнопка из tsx</button>;
export default Button;
```


Это отображается так:


#### кнопка

Текст из MDX
Кнопка из tsx

## Альтернативный способ: написание страниц на TSX

```tsx file="./_escape-hatch.tsx" title="_escape-hatch.tsx"
import { getCustomMDXComponent } from '@rspress/core/theme';

export default () => {
  const { p: P, code: Code } = getCustomMDXComponent();
  return (
    <P className="rp-doc">
      Это содержимое в tsx, но стили такие же, как в документации, например,
      <Code>@rspress/core</Code>. Однако этот текст с className="rp-not-doc"
      <Code className="rp-not-doc">@rspress/core</Code> не будет стилизоваться
    </P>
  );
};

```

Это отображается как:


Это содержимое в tsx, но стили такие же, как в документации, например,`@rspress/core`. Однако этот текст с className="rp-not-doc"`@rspress/core` не будет стилизоваться


:::warning Предупреждение

Синтаксис TSX и HTML затрудняет извлечение статической информации, например, индексов для локального поиска.

Мы рекомендуем использовать файлы `.mdx` для содержимого документов и файлы `.tsx` для интерактивного динамического контента.

:::

## Требования к версиям React

| Зависимость        | Допустимый диапазон | Версия по умолчанию | Примечания |    |                                                    |
| ------------------ | ------------------- | ------------------- | ---------- | -- | -------------------------------------------------- |
| `react`            | \`^18.0.0           |                     | ^19.0.0\`  | 19 | React 17 больше не поддерживается                  |
| `react-dom`        | \`^18.0.0           |                     | ^19.0.0\`  | 19 | Должна быть согласована с версией react            |
| `react-router-dom` | \`^6.0.0            |                     | ^7.0.0\`   | 7  | Использует версию из проекта, если уже установлена |

:::tip

Если `react`, `react-dom` или `react-router-dom` уже установлены в вашем проекте, Rspress будет в первую очередь использовать версию, установленную в вашем проекте, а не встроенную версию по умолчанию.

:::
