# Rspress по-русски > Документация Rspress на русском языке ## Руководство - [Введение](/rspress-russian/guide/start/introduction.md): Rspress — высокопроизводительный генератор статических сайтов на базе Rsbuild с запуском на уровне миллисекунд, ИИ-нативным SSG-MD, поддержкой MDX, полнотекстовым поиском, i18n и многоверсионной документацией. - [Быстрый старт](/rspress-russian/guide/start/getting-started.md): Быстро создайте проект Rspress с помощью шаблона или вручную, и изучите базовый рабочий процесс, включая запуск dev-сервера, сборку для продакшена и локальный предпросмотр. - [ИИ](/rspress-russian/guide/start/ai.md): Используйте навыки агентов, llms.txt, Markdown-документацию и AGENTS.md, чтобы помочь агентам для программирования работать с Rspress. - [Файловая маршрутизация](/rspress-russian/guide/basic/conventional-route.md): Rspress использует маршрутизацию на основе файловой системы для сопоставления путей файлов с URL-маршрутами, с поддержкой `pageType` в метаданных и пользовательской конфигурации маршрутов. - [Автонавигация](/rspress-russian/guide/basic/auto-nav-sidebar.md): Автоматически генерируйте навигационную панель и боковую панель через _nav.json и _meta.json, с поддержкой файлов, директорий, заголовков разделов, пользовательских ссылок и многого другого. - [Статические ресурсы](/rspress-russian/guide/basic/static-assets.md): Настройка логотипов сайта, favicon, изображений и видео в MDX-файлах, а также директории `public` для пользовательских статических ресурсов. - [Генерация статического сайта (SSG)](/rspress-russian/guide/basic/ssg.md): Предварительно рендерите страницы в статический HTML во время сборки для более быстрой загрузки, лучшего SEO и лёгкого развёртывания на любом сервисе статического хостинга. - [llms.txt (SSG-MD)](/rspress-russian/guide/basic/ssg-md.md): Генерируйте llms.txt и Markdown-файлы для ИИ-нативной документации с помощью SSG-MD, обеспечивая лучшее понимание большими языковыми моделями. - [WebMCP](/rspress-russian/guide/basic/webmcp.md): Rspress включает webMcp по умолчанию, поэтому агенты могут использовать WebMCP, чтобы искать, читать и перемещаться по документации Rspress. Подробнее см. в ChatGPT - Site tools. Установите webMcp: false, чтобы отключить встроенные инструменты Rspress. Хук useWebMcp по-прежнему доступен для регистрации собственных инструментов. - [i18n](/rspress-russian/guide/basic/i18n.md): Настройте языки, организуйте многоязычную документацию и локализуйте навигацию; при необходимости определите текстовые данные i18n и используйте хук useI18n. - [Мультиверсионность](/rspress-russian/guide/basic/multi-version.md): Стандартная тема Rspress поддерживает документацию с несколькими версиями. В этом руководстве показано, как включить и организовать такие версии. - [Главная страница](/rspress-russian/guide/basic/home-page.md): Настраивайте содержимое главной страницы через метаданные, включая секцию hero, карточки возможностей и пользовательские компоненты. - [Развёртывание](/rspress-russian/guide/basic/deploy.md): Разверните сайты Rspress с продакшен-сборкой, префиксом статических ресурсов, конфигурацией базового пути и руководствами для конкретных платформ для GitHub Pages, Netlify и Vercel. - [Кастомная тема](/rspress-russian/guide/basic/custom-theme.md): Настраивайте тему с помощью CSS-переменных, BEM-классов, обёрток компонентов со слотами или извлечённых встроенных компонентов для полного контроля. - [MDX и React-компоненты](/rspress-russian/guide/use-mdx/components.md): Используйте MDX для импорта и рендеринга React-компонентов в Markdown с поддержкой фрагментов документов и пользовательских слотов компонентов. - [Метаданные](/rspress-russian/guide/use-mdx/frontmatter.md): Определяйте метаданные страницы с помощью метаданных YAML, включая title, description, pageType, sidebar, outline и многое другое. - [Блоки кода](/rspress-russian/guide/use-mdx/code-blocks.md): Используйте Shiki для подсветки синтаксиса с поддержкой подсветки строк, заголовков кода, номеров строк, подсветки слов, отображения diff и сворачивания кода. - [Ссылки](/rspress-russian/guide/use-mdx/link.md): Поддержка форматов ссылок по пути к файлу и URL, якорных ссылок, пользовательских ID якорей и обнаружения битых ссылок. - [Контейнеры](/rspress-russian/guide/use-mdx/container.md): Создавайте пользовательские контейнеры с синтаксисом ::: или GitHub Markdown Alerts для блоков tip, warning, danger, note и details. - [Страница обзора](/rspress-russian/guide/advanced/overview-page.md): Включите обзорную страницу через секцию overview в метаданных, автоматически извлекая информацию из боковой панели для генерации содержимого обзора. - [Расширение сборки](/rspress-russian/guide/advanced/extend-build.md): Расширяйте поведение сборки с помощью конфигурации Rsbuild, плагинов Rspack и пользовательских плагинов remark/rehype для MDX. - [Настройка тегов head / SEO](/rspress-russian/guide/advanced/custom-head.md): Добавление тегов head (например, мета-тегов) на веб-страницы крайне важно для оптимизации SEO и корректного отображения при шаринге в социальных сетях. Например, протокол Open Graph управляет тем, как страница будет выглядеть при публикации в соцсетях. На данный момент Rspress автоматически добавляет следующие теги head: - [Настройка поиска](/rspress-russian/guide/advanced/custom-search.md): Расширьте функциональность поиска с помощью searchHooks для обработки ключевых слов, фильтрации результатов, отчётов аналитики и пользовательских источников данных. - [Миграция с Rspress 1.x](/rspress-russian/guide/migration/rspress-1-x.md): Полное руководство по миграции с Rspress 1.x на V2, охватывающее изменение названий пакетов, путей импорта, пользовательских тем, подсветки кода Shiki и многое другое. ## Плагины - [Введение](/rspress-russian/plugin/system/introduction.md): Знакомство с системой плагинов Rspress и с тем, как она расширяет процесс сборки сайта и поведение браузерного runtime. - [Написание плагина](/rspress-russian/plugin/system/write-a-plugin.md): Создание и регистрация плагина Rspress, который внедряет глобальный UI-компонент и переменные этапа сборки. - [API плагинов](/rspress-russian/plugin/system/plugin-api.md): API плагинов Rspress для расширения сборки сайта и поведения в браузерном runtime, включая генерацию страниц и обработку Markdown. - [Обзор](/rspress-russian/plugin/official-plugins/overview.md): Официальные плагины Rspress, включая интеграции для поиска, API-документации и предпросмотра компонентов. - [@rspress/plugin-llms](/rspress-russian/plugin/official-plugins/llms.md): Генерация llms.txt и Markdown-файлов с помощью @rspress/plugin-llms как запасной вариант, когда нельзя включить SSG и SSG-MD. - [@rspress/plugin-sitemap](/rspress-russian/plugin/official-plugins/sitemap.md): Генерация sitemap для Rspress с помощью @rspress/plugin-sitemap и настройка URL сайта и полей sitemap для отдельных страниц. - [@rspress/plugin-client-redirects](/rspress-russian/plugin/official-plugins/client-redirects.md): Настройка клиентских перенаправлений страниц с помощью @rspress/plugin-client-redirects, включая требования к странице возврата при развёртывании. - [@rspress/plugin-typedoc](/rspress-russian/plugin/official-plugins/typedoc.md): Генерация API-документации для модулей TypeScript с помощью @rspress/plugin-typedoc и настройка точек входа, вывода и конфигурации TypeDoc. - [@rspress/plugin-api-docgen](/rspress-russian/plugin/official-plugins/api-docgen.md): Генерация справочников по API React-компонентов и JavaScript с помощью @rspress/plugin-api-docgen на основе исходных файлов и параметров парсера. - [@rspress/plugin-preview](/rspress-russian/plugin/official-plugins/preview.md): Предпросмотр компонентов из блоков кода MDX или локальных файлов с помощью @rspress/plugin-preview, включая режимы предпросмотра в iframe. - [@rspress/plugin-playground](/rspress-russian/plugin/official-plugins/playground.md): Добавление интерактивной редактируемой площадки для предпросмотра компонентов в блоки MDX-кода Rspress с помощью @rspress/plugin-playground и компиляции в браузере. - [@rspress/plugin-rss](/rspress-russian/plugin/official-plugins/rss.md): Генерация RSS-, Atom- или JSON-лент из выбранных страниц Rspress с помощью @rspress/plugin-rss и настройка содержимого и вывода лент. - [@rspress/plugin-algolia](/rspress-russian/plugin/official-plugins/algolia.md): Замена встроенного поиска на Algolia DocSearch с помощью @rspress/plugin-algolia и настройка краулинга и результатов для отдельных локалей. - [@rspress/plugin-twoslash](/rspress-russian/plugin/official-plugins/twoslash.md): Добавление всплывающих подсказок типов TypeScript, автодополнений и аннотаций ошибок в блоки кода Rspress с помощью @rspress/plugin-twoslash. - [Обзор](/rspress-russian/plugin/community-plugins/overview.md): Знакомьтесь с плагинами Rspress от сообщества и узнайте, как публиковать и распространять собственные плагины. - [rspress-plugin-typesense](/rspress-russian/plugin/community-plugins/typesense.md): Интеграция поиска Typesense в Rspress с автоматической индексацией во время сборки, поддержкой мультиверсионности и многоязычным поиском. - [rspress-plugin-third-parties](/rspress-russian/plugin/community-plugins/third-party.md): Встраивайте видео YouTube, твиты и Google Карты, добавляйте Google Analytics или Tag Manager и управляйте загрузкой скриптов в Rspress. ## UI - [CSS-переменные](/rspress-russian/ui/vars.md): Список встроенных CSS-переменных Rspress для настройки брендовых цветов, стилей блоков кода и конфигурации темы. - [Настройка страницы](/rspress-russian/ui/custom-page.md): Способы настройки макета страницы, глобальных компонентов, стилей и тегов head. - [Tailwind CSS](/rspress-russian/ui/tailwindcss.md): Интеграция Tailwind CSS v4 в Rspress с помощью плагина Rsbuild и глобальных стилей, а затем использование утилитарных классов в MDX. - [shadcn/ui](/rspress-russian/ui/shadcn-ui.md): Настройка компонентов shadcn/ui в Rspress с Tailwind CSS: алиасы путей, конфигурация компонентов и импорты в MDX. - [Компоненты документации](/rspress-russian/ui/components/index.md): Встроенные компоненты документации Rspress, включая часто используемые UI-компоненты для написания документации. - [Badge](/rspress-russian/ui/components/badge.md): Компонент Badge для отображения небольших встроенных меток в документации с поддержкой различных типов и стилей. - [Callout](/rspress-russian/ui/components/callout.md): Компонент Callout для отображения выделенных информационных блоков, таких как советы, предупреждения и примечания. - [CdnTabs](/rspress-russian/ui/components/cdn-tabs.md): Компонент CdnTabs для отображения CSS- и JavaScript-файлов, размещённых на CDN. - [CodeBlockRuntime](/rspress-russian/ui/components/code-block-runtime.md): Компонент CodeBlockRuntime для динамического рендеринга исполняемых блоков кода во время выполнения. - [PackageManagerTabs](/rspress-russian/ui/components/package-manager-tabs.md): Компонент PackageManagerTabs для отображения команд установки для разных менеджеров пакетов. - [PageTabs](/rspress-russian/ui/components/page-tabs.md): Компонент PageTabs для создания нескольких под вкладок в пределах одной страницы. - [Prompt](/rspress-russian/ui/components/prompt.md): Компонент Prompt для выделяющихся, копируемых инструкций для агента или пользовательского MDX-содержимого. - [SourceCode](/rspress-russian/ui/components/source-code.md): Компонент SourceCode для рендеринга ссылок на исходный код в репозиториях GitHub или GitLab. - [Steps](/rspress-russian/ui/components/steps.md): Компонент Steps для рендеринга Markdown-контента в виде блоков пошаговых инструкций. - [Tabs/Tab](/rspress-russian/ui/components/tabs.md): Компонент Tabs для переключения между несколькими панелями контента с поддержкой синхронизации групп. - [Runtime-компоненты](/rspress-russian/ui/runtime-components/index.md): Обзор runtime-компонентов Rspress, включая Head, NoSSR и BrowserOnly для использования во время выполнения. - [BrowserOnly](/rspress-russian/ui/runtime-components/browser-only.md): Компонент BrowserOnly для рендеринга контента только в браузере после гидратации. - [Head](/rspress-russian/ui/runtime-components/head.md): Компонент Head для внедрения пользовательского контента в head страниц документа, например мета-тегов и ссылок. - [NoSSR](/rspress-russian/ui/runtime-components/no-ssr.md): Компонент NoSSR для отключения серверного рендеринга и отображения контента только на клиенте. - [Встроенные иконки](/rspress-russian/ui/icons/index.md): Список встроенных иконок Rspress и способов их замены через кастомную тему. - [Компоненты макета](/rspress-russian/ui/layout-components/index.md): Обзор встроенных компонентов макета Rspress, включая макеты главной страницы и страницы Overview по умолчанию. - [Banner](/rspress-russian/ui/layout-components/banner.md): Компонент уведомления Banner для отображения сообщений в верхней части страницы с навигацией по ссылке и возможностью закрытия. - [DocFooter](/rspress-russian/ui/layout-components/doc-footer.md): Компонент DocFooter для нижней части страницы документа, содержащий ссылку на редактирование, время последнего обновления и навигацию по предыдущей/следующей странице. - [EditLink](/rspress-russian/ui/layout-components/edit-link.md): Компонент EditLink для рендеринга ссылки «Редактировать эту страницу», ведущей на страницу редактирования исходного файла документа. - [getCustomMDXComponent](/rspress-russian/ui/layout-components/get-custom-mdx-component.md): getCustomMDXComponent — API темы для переопределения стандартных рендереров MDX-элементов в макетах документации Rspress. - [HomeBackground](/rspress-russian/ui/layout-components/home-background.md): Компонент HomeBackground для рендеринга фоновых эффектов на главной странице и автоматической установки прозрачной навигационной панели. - [HomeFeature](/rspress-russian/ui/layout-components/home-feature.md): Компонент HomeFeature для рендеринга карточек сетки функций под секцией Hero на главной странице. - [HomeFooter](/rspress-russian/ui/layout-components/home-footer.md): Компонент HomeFooter для рендеринга информации футера в нижней части главной страницы. - [HomeHero](/rspress-russian/ui/layout-components/home-hero.md): Компонент HomeHero для рендеринга секции Hero на главной странице, включая заголовок, описание и кнопки действий. - [HomeLayout](/rspress-russian/ui/layout-components/home-layout.md): Компонент HomeLayout для рендеринга общего макета главной страницы, включая секции Hero, Features и Footer. - [LastUpdated](/rspress-russian/ui/layout-components/last-updated.md): Компонент LastUpdated для отображения автора и времени последнего обновления страницы. - [Layout](/rspress-russian/ui/layout-components/layout.md): Компонент макета, служит контейнером макета для всей страницы, предоставляя богатые слот-пропсы для пользовательских расширений. - [NavList](/rspress-russian/ui/layout-components/nav-list.md): NavList отображает пользовательские элементы навигации в настольной панели навигации и мобильном меню. - [NavTitle](/rspress-russian/ui/layout-components/nav-title.md): Настройка компонента NavTitle в Rspress: логотипы и заголовки сайта, свойство navTitle компонента Layout и настройки локалей. - [OverviewGroup](/rspress-russian/ui/layout-components/overview-group.md): Компонент OverviewGroup для рендеринга карточек групп и списков страниц на страницах overview. - [PrevNextPage](/rspress-russian/ui/layout-components/prev-next-page.md): Компонент PrevNextPage для рендеринга ссылок навигации по предыдущей/следующей странице в нижней части страницы. - [Root](/rspress-russian/ui/layout-components/root.md): Корневой компонент, служит оберткой для всего приложения, используется для оборачивания пользовательских Providers. - [Tag](/rspress-russian/ui/layout-components/tag.md): Компонент Tag для отображения меток в боковой панели или навигационной панели, поддерживает встроенные теги, SVG и изображения. - [Встроенные хуки](/rspress-russian/ui/hooks/index.md): Обзор встроенных React-хуков Rspress для доступа к данным страницы, состоянию темы и информации о роутинге. - [Хуки роутера](/rspress-russian/ui/hooks/router-hooks.md): Хуки роутера, переэкспортированные из react-router-dom для доступа к информации о навигации и местоположении. - [useDark](/rspress-russian/ui/hooks/use-dark.md): Хук useDark для определения, используется ли сейчас темная тема. - [useFrontmatter](/rspress-russian/ui/hooks/use-frontmatter.md): Хук useFrontmatter для доступа к метаданным текущей страницы. - [useHead](/rspress-russian/ui/hooks/use-head.md): Хук useHead для объявления тегов head документа в React-компонентах и макетах. - [useI18n](/rspress-russian/ui/hooks/use-i18n.md): Хук useI18n для чтения настроенного многоязычного текста в пользовательских компонентах. - [useLang](/rspress-russian/ui/hooks/use-lang.md): Хук useLang для получения кода текущего языка для многоязычного рендеринга и навигации по маршрутам. - [usePageData](/rspress-russian/ui/hooks/use-page-data.md): Хук usePageData для доступа к метаданным текущей страницы устарел, используйте usePage вместо него. - [usePage](/rspress-russian/ui/hooks/use-page.md): Хук usePage для доступа к метаданным текущей страницы Markdown/MDX. - [usePages](/rspress-russian/ui/hooks/use-pages.md): Хук usePages для доступа к метаданным всех страниц на сайте. - [useSite](/rspress-russian/ui/hooks/use-site.md): Хук useSite для доступа к нормализованной конфигурации сайта из rspress.config.ts. - [useVersion](/rspress-russian/ui/hooks/use-version.md): Хук useVersion для получения текущей версии документации в мультиверсионных доках. - [useWebMcp](/rspress-russian/ui/hooks/use-web-mcp.md): Регистрируйте собственные WebMCP-инструменты компонентов для браузерных агентов с помощью useWebMcp. ## API - [Обзор API](/rspress-russian/api/index.md): Справочник по API Rspress, включая команды CLI, базовую конфигурацию, конфигурацию сборки и темы. - [Базовая конфигурация](/rspress-russian/api/config/config-basic.md): Базовые параметры конфигурации Rspress, включая метаданные сайта, локали, маршруты и поиск. - [Конфигурация ИИ](/rspress-russian/api/config/config-agent.md): Эти опции настраивают генерацию Markdown и инструменты для браузерных агентов. llms и webMcp — опции верхнего уровня в rspress.config.ts. - [Конфигурация темы](/rspress-russian/api/config/config-theme.md): Настройка темы Rspress по умолчанию через themeConfig, включая навигацию, боковую панель, оформление, поиск и llmsUI. - [Конфигурация метаданных](/rspress-russian/api/config/config-frontmatter.md): На этой странице описывается, как настраивать свойства уровня страницы с помощью метаданных, включая заголовок, описание, тип страницы и видимость навигационной панели. См. метаданные для получения информации о синтаксисе метаданных и useFrontmatter для получения информации о том, как обращаться к метаданным в коде. - [Конфигурация сборки](/rspress-russian/api/config/config-build.md): Настройка Rsbuild и компиляции Markdown в Rspress, включая плагины, подсветку синтаксиса и проверку ссылок. - [Команды](/rspress-russian/api/commands.md): Команды и параметры CLI Rspress, включая dev, build, preview и eject. ## Блог - [Новости Rspress](/rspress-russian/blog/index.md): Анонсы релизов Rspress и статьи об инструментах для документации и разработке сайтов. - [Анонс Rspress 2.1.0](/rspress-russian/blog/rspress-v2-1.md): Rspress 2.1.0 включает SSG-MD, чистые URL и проверку якорей по умолчанию, добавляет встроенные WebMCP и карту сайта, а также улучшает стили панели поиска и восстановление прокрутки. - [Как создать сайт, удобный для агентов](/rspress-russian/blog/agent-friendly-website.md): Rspress использует llms.txt, SSG-MD, Accept: text/markdown и injectLlmsHint, чтобы помочь агентам обнаруживать документацию и читать её. - [Проблема завершающего слеша в статических сайтах](/rspress-russian/blog/trailing-slash.md): Реальный пример того, как завершающие слеши могут ломать относительные ссылки и как Rspress решает эту проблему. - [Анонс Rspress 2.0](/rspress-russian/blog/rspress-v2.md): Rspress 2.0 официально выпущен, в нём представлена совершенно новая тема, ИИ-нативный SSG-MD и генерация llms.txt, подсветка кода Shiki, lazyCompilation, а также более удобные инструменты разработки документации.