Базовая конфигурация

root

Тип: string
По умолчанию: docs

Указывает корневой каталог документации. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  root: 'docs',
});

Эта опция поддерживает как относительные, так и абсолютные пути. Относительные пути разрешаются относительно текущей рабочей директории (cwd).

В качестве аргумента командной строки также можно передать корневой каталог документации:

rspress dev docs
rspress build docs

base

Тип: string
По умолчанию: /

Базовый путь для развёртывания. Например, если вы планируете разместить сайт по адресу https://foo.github.io/bar/, то значение base нужно установить в "/bar/":

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  base: '/bar/',
});

siteOrigin

Добавлено в v2.0.17

Тип: string
По умолчанию: ""

Необязательный базовый URL, по которому развёрнут сайт, например https://foo.github.io.

Rspress использует это значение вместе с параметром base, когда при генерации файлов требуются абсолютные URL, например для ссылок в llms.txt или данных, создаваемых плагинами. Полный URL формируется в следующем порядке: siteOrigin + base + routePath.

Если siteOrigin не задан, Rspress использует в качестве альтернативы base + routePath.

Если ваш сайт развёрнут по адресу https://foo.github.io/bar/, установите siteOrigin в "https://foo.github.io", а base — в "/bar/":

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  siteOrigin: 'https://foo.github.io',
  base: '/bar/',
});

title

Тип: string
По умолчанию: "Rspress"

Название сайта. Rspress использует его в качестве заголовка HTML-страницы. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  title: 'My Site',
});

description

Тип: string
По умолчанию: ""

Описание сайта. Rspress использует его в качестве описания HTML-страницы. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  description: 'My Site Description',
});

icon

Тип: string | URL
По умолчанию: ""

Иконка сайта. Rspress использует этот путь в качестве иконки HTML-страницы. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  icon: '/favicon.ico',
});

Для обычного пути Rspress ищет иконку в каталоге public. Также можно использовать URL CDN, протокол file:// или объект URL, указывающий на локальный абсолютный путь.

lang

Тип: string
По умолчанию: "en"

Язык сайта по умолчанию. Подробности см. в разделе Интернационализация.

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  lang: 'en',
  locales: [
    {
      lang: 'en',
      // ...
    },
    {
      lang: 'ru',
      // ...
    },
  ],
});

i18nSourcePath

Тип: string
По умолчанию: path.join(cwd, 'i18n.json')

Указывает путь к файлу источника данных i18n. По умолчанию Rspress читает файл i18n.json из текущей рабочей директории. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';
import path from 'path';

export default defineConfig({
  i18nSourcePath: path.join(__dirname, 'config/i18n.json'),
});

Совет

Это имеет тот же эффект, что и размещение файла i18n.json в корне проекта. Если также настроен i18nSource, то данные из i18nSource будут объединены с данными из i18nSourcePath и имеют приоритет.

i18nSource

Тип: Record<string, Record<string, string>> | ((value: Record<string, Record<string, string>>) => Record<string, Record<string, string>> | Promise<Record<string, Record<string, string>>>)
По умолчанию: {}

Используйте этот параметр, чтобы изменить встроенные локализованные строки Rspress или добавить строки для пользовательских компонентов. Обычно он используется вместе с useI18n.

Совет

Реализация и эффект полностью совпадают с файлом i18n.json. Можно использовать любой из этих способов. Параметр i18nSource имеет более высокий приоритет, чем i18n.json, и поддерживает функции.

Параметр i18nSource — это объект со следующей структурой:

{
  [textKey: string]: {
    [locale: string]: string;
  }
}

На первом уровне ключом является идентификатор текста (textKey), на втором — код языка (locale, например ru или en), а значением — перевод текста для соответствующего языка.

Вот пример изменения встроенных i18n-текстов Rspress:

rspress.config.ts

import { defineConfig } from '@rspress/core';
export default defineConfig({
  i18nSource: {
    editLinkText: {
      en: '📝 Edit this page on Gitlab',
      ru: '📝 Изменить эту страницу на Gitlab',
    },
  },
});

i18nSource также может быть функцией, например:

import { defineConfig } from '@rspress/core';

export default defineConfig({
  i18nSource: async source => {
    for (const key of Object.keys(source)) {
      source[key]['en_US'] = source[key]['en'];
    }
    return source;
  },
});

Вот встроенные строки i18n в Rspress:

const DEFAULT_I18N_TEXT = {
  // Основные строки интерфейса
  searchPlaceholder: 'Поиск',
  theme: 'Тема',
  darkMode: 'Тёмная тема',
  lightMode: 'Светлая тема',
  // И другие строки...
};

logo

Тип: string | { dark: string; light: string }
По умолчанию: ""

Логотип сайта. Rspress использует его в качестве логотипа в левом верхнем углу панели навигации. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  logo: '/logo.png',
});

Rspress ищет логотип в каталоге public. Также можно использовать URL CDN.

Кроме того, можно задать разные логотипы для светлой и тёмной тем:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  logo: {
    dark: '/logo-dark.png',
    light: '/logo-light.png',
  },
});

logoHref

Тип: string
По умолчанию: /${lang}/

Пользовательский ссылка для логотипа. По умолчанию при клике на логотип происходит переход на главную страницу текущего языка. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  logo: '/logo.png',
  logoHref: 'https://example.com',
});

logoText

Тип: string
По умолчанию: ""

Текст логотипа сайта. Rspress отображает его в левом верхнем углу панели навигации. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  logoText: 'rspress',
});

outDir

Тип: string
По умолчанию: doc_build

Пользовательская директория для вывода собранного сайта. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  outDir: 'doc_build',
});

themeDir

Тип: string
По умолчанию: theme

Указывает директорию пользовательской темы. По умолчанию Rspress использует директорию theme в текущей рабочей директории в качестве директории пользовательской темы. Вы можете использовать themeDir для её настройки. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';
import path from 'path';

export default defineConfig({
  themeDir: path.join(__dirname, 'my-theme'),
});

Эта опция поддерживает как относительные, так и абсолютные пути. Относительные пути разрешаются относительно текущей рабочей директории.

Подробнее о пользовательских темах см. Кастомная тема.

locales

Тип: Locale[]

export interface Locale {
  lang: string;
  label: string;
  title?: string;
  description?: string;
}

Настройка интернационализации (i18n) сайта. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  locales: [
    {
      lang: 'en-US',
      label: 'English',
      title: 'My Site',
      description: 'My site description',
    },
    {
      lang: 'ru-RU',
      label: 'Русский',
      title: 'Заголовок сайта',
      description: 'Описание сайта',
    },
  ],
});

head

Тип: string | [string, Record<string, string>] | (route) => string | [string, Record<string, string>] | undefined
Можно дополнять на отдельной странице через метаданные

Добавляет дополнительные элементы в HTML-элемент <head> страницы при продакшен-сборке.

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  // ... другие настройки
  head: [
    '<meta name="author" content="John Doe">',
    // или
    ['meta', { name: 'author', content: 'John Doe' }],
    // [htmlTag, { attrName: attrValue, attrName2: attrValue2 }]
    // или
    route => {
      if (route.routePath.startsWith('/jane/'))
        return "<meta name='author' content='Jane Doe'>";
      if (route.routePath.startsWith('/john/'))
        return ['meta', { name: 'author', content: 'John Doe' }];
      // или вообще ничего не возвращаем
      return undefined;
    },
  ],
});

globalStyles

Тип: string
По умолчанию: undefined

Добавляет глобальные стили из указанного файла стилей. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';
import path from 'path';

export default defineConfig({
  globalStyles: path.join(__dirname, 'styles/global.css'),
});

styles/global.css

:root {
  --rp-c-brand: #f00;
}

llms

Тип:

boolean | {
  llmsTxt?: (context: LlmsTxtContext) => string | Promise<string>;
  remarkSplitMdxOptions?: RemarkSplitMdxOptions;
}

По умолчанию: false

Включает генерацию SSG-MD для создания файлов llms.txt, llms-full.txt и Markdown-файлов для каждой страницы, что облегчает понимание вашей документации большими языковыми моделями.

Используйте llmsTxt для формирования полного содержимого llms.txt на основе метаданных сайта и разделов страниц. Подробности см. в разделе Настройка llms.txt.

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  llms: true,
});

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

llms — это экспериментальная функция. Если SSG-MD не удается включить из-за несовместимости с SSR, используйте в качестве запасного варианта @rspress/plugin-llms.

Подробное использование, параметры конфигурации и принципы реализации см. в разделе llms.txt (SSG-MD).

mediumZoom

Тип: boolean | { selector?: string }
По умолчанию: true

Определяет, включён ли режим увеличения изображений. По умолчанию он включён; установите mediumZoom в false, чтобы отключить его.

Увеличение изображений реализовано с помощью библиотеки medium-zoom.

Пример использования:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  // Отключите увеличение изображений
  mediumZoom: false,
  // Настройте CSS-селектор для изображений, которые могут увеличиваться при масштабировании. По умолчанию используется '.rspress-doc img'
  mediumZoom: {
    selector: '.rspress-doc img',
  },
});

search

Тип:

type SearchOptions = {
  searchHooks?: string;
  versioned?: boolean;
  codeBlocks?: boolean;
};

Совет

Чтобы исключить отдельную страницу из поискового индекса, установите search: false в её метаданных.

searchHooks

Тип: string
По умолчанию: undefined

Используйте searchHooks для добавления пользовательской логики во время выполнения поиска. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';
import path from 'path';

export default defineConfig({
  search: {
    searchHooks: path.join(__dirname, 'searchHooks.ts'),
  },
});

Подробную информацию о хуках можно найти в разделе Настройка поиска.

versioned

Тип: boolean
По умолчанию: true

При использовании multiVersion по умолчанию для каждой версии создаётся отдельный индекс поиска, благодаря чему результаты поиска содержат только страницы из той версии, которую пользователь просматривает в данный момент. Установите versioned в false, чтобы отключить это поведение и включить в результаты поиска все версии.

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  search: {
    versioned: false,
  },
});

codeBlocks

Тип: boolean
По умолчанию: true

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

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  search: {
    codeBlocks: false,
  },
});

globalUIComponents

Тип: (string | [string, object])[]
По умолчанию: []

Через параметр globalUIComponents можно зарегистрировать глобальные UI-компоненты, например:

rspress.config.ts

import { defineConfig } from '@rspress/core';
import path from 'path';

export default defineConfig({
  globalUIComponents: [path.join(__dirname, 'components', 'MyComponent.tsx')],
});

Каждый элемент globalUIComponents может быть либо строкой с путём к файлу компонента, либо кортежем. В форме кортежа первый элемент — путь к файлу компонента, второй — пропсы компонента. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  globalUIComponents: [
    [
      path.join(__dirname, 'components', 'MyComponent.tsx'),
      {
        foo: 'bar',
      },
    ],
  ],
});

При регистрации глобальных компонентов Rspress автоматически рендерит эти React-компоненты в теме без необходимости их ручного импорта.

Глобальные компоненты могут реализовывать различные пользовательские функции, такие как:

compUi.tsx

import React from 'react';

// Необходим экспорт по умолчанию
// Пропсы приходят из вашей конфигурации
export default function PluginUI(props?: { foo: string }) {
  return <div>Это глобальный компонент макета</div>;
}

Содержимое компонента затем рендерится в теме, например для добавления кнопки BackToTop.

Также глобальный компонент можно использовать для регистрации побочных эффектов:

compSideEffect.tsx

import { useEffect } from 'react';
import { useLocation } from '@rspress/core/runtime';

// Необходим экспорт по умолчанию
export default function PluginSideEffect() {
  const { pathname } = useLocation();
  useEffect(() => {
    // Выполняется при первом рендере компонента
  }, []);

  useEffect(() => {
    // Выполняется при изменении маршрута
  }, [pathname]);
  return null;
}

Побочные эффекты компонента затем выполняются в теме. Например, они полезны для:

Перенаправления определённых маршрутов страниц.
Привязки событий клика к тегам img на странице для реализации увеличения изображений.
Отправки данных о просмотрах страниц при изменении маршрута.

multiVersion

Тип: { default: string; versions: string[] }

Включите поддержку нескольких версий с помощью multiVersion. Например:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  multiVersion: {
    default: 'v1',
    versions: ['v1', 'v2'],
  },
});

Параметр default — это версия по умолчанию, а versions — список всех доступных версий.

route

Тип: Object

Пользовательская настройка маршрутов.

route.include

Тип: string[]
По умолчанию: []

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

import { defineConfig } from '@rspress/core';

export default defineConfig({
  route: {
    include: ['other-dir/**/*.{md,mdx}'],
  },
});

Примечание: строки в массиве поддерживают glob-шаблоны. Glob-выражение должно быть задано относительно корневого каталога документации и включать соответствующие расширения файлов.

Примечание

Для более гибкой настройки маршрутов страниц и сопоставления файлов с содержимым рекомендуется использовать хук addPages в собственном плагине Rspress.

route.exclude

Тип: string[]
По умолчанию: []

Исключить некоторые файлы из маршрутов. Например:

import { defineConfig } from '@rspress/core';

export default defineConfig({
  route: {
    exclude: ['custom.tsx', 'component/**/*'],
  },
});

Примечание: строки в массиве поддерживают glob-шаблоны. Glob-выражение должно быть задано относительно корневого каталога документации.

route.excludeConvention

Тип: string[]
По умолчанию: ['**/_[^_]*']

Соглашение о маршрутизации, упрощающее хранение компонентов в каталоге документации. По умолчанию файлы, имена которых начинаются с _, исключаются.

Если вам действительно нужны маршруты, начинающиеся с _, вы можете изменить это правило, например, задать исключение только для файлов, начинающихся с _fragment-:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  route: {
    excludeConvention: ['**/_fragment-*'],
  },
});

route.extensions

Тип: string[]
По умолчанию: ['.js', '.jsx', '.ts', '.tsx', '.md', '.mdx']

Расширения файлов, которые следует включать в таблицу маршрутов. По умолчанию Rspress включает все файлы с расширениями 'js', 'jsx', 'ts', 'tsx', 'md' и 'mdx'. Чтобы задать собственный список расширений, используйте эту опцию:

import { defineConfig } from '@rspress/core';

export default defineConfig({
  route: {
    extensions: ['.md', '.mdx'],
  },
});

route.cleanUrls

Тип: Boolean
По умолчанию: false

Генерирует URL-адреса без расширений файлов, если параметр cleanUrls имеет значение true.

Требуется поддержка сервера

При включении этой функции может потребоваться дополнительная настройка на вашей хостинг-платформе. Для корректной работы сервер должен отдавать файл /foo.html при обращении по адресу /foo без редиректа.

import { defineConfig } from '@rspress/core';

export default defineConfig({
  route: {
    cleanUrls: true,
  },
});

route.cleanUrlsRedirect

Тип: Boolean
По умолчанию: true

При включении этой опции Rspress нормализует неканонические URL-адреса в браузере во время запуска клиентского приложения, используя фактически сопоставленный маршрут как единственный источник истины. Итоговый формат URL определяется параметром route.cleanUrls.

Параметр route.cleanUrls задаёт предпочтительный формат URL, используемый в генерируемых ссылках, тогда как route.cleanUrlsRedirect отвечает только за нормализацию адресной строки браузера.

Клиентская нормализация

Эта опция выполняется после загрузки HTML запрошенной страницы и клиентского приложения. Она использует history.replaceState и не возвращает HTTP-перенаправление с кодом 301/308, поэтому не может полностью заменить каноническое перенаправление на стороне сервера или CDN, особенно с точки зрения SEO. Хостинг-платформа всё равно должна отдавать корректную страницу Rspress для запрошенного варианта URL. Если есть возможность, предпочтительно использовать перенаправление на стороне сервера.

При `cleanUrls: true`

URL обычных страниц не содержат завершающего слеша, а URL индексных страниц каталогов сохраняют его.

Входящий URL	Сопоставленный маршрут	Изменение URL в браузере
`/file`	`/file`	Без изменений
`/file.html`	`/file`	`replaceState` → `/file`
`/file/`	`/file`	`replaceState` → `/file`
`/file/index`	`/file`	`replaceState` → `/file`
`/file/index.html`	`/file`	`replaceState` → `/file`
`/folder`	`/folder/`	`replaceState` → `/folder/`
`/folder.html`	`/folder/`	`replaceState` → `/folder/`
`/folder/`	`/folder/`	Без изменений
`/folder/index`	`/folder/`	`replaceState` → `/folder/`
`/folder/index.html`	`/folder/`	`replaceState` → `/folder/`

При `cleanUrls: false`

Для обычных страниц используется суффикс .html, а для индексных страниц каталогов — /index.html.

Входящий URL	Сопоставленный маршрут	Изменение URL в браузере
`/file`	`/file`	`replaceState` → `/file.html`
`/file.html`	`/file`	Без изменений
`/file/`	`/file`	`replaceState` → `/file.html`
`/file/index`	`/file`	`replaceState` → `/file.html`
`/file/index.html`	`/file`	`replaceState` → `/file.html`
`/folder`	`/folder/`	`replaceState` → `/folder/index.html`
`/folder.html`	`/folder/`	`replaceState` → `/folder/index.html`
`/folder/`	`/folder/`	`replaceState` → `/folder/index.html`
`/folder/index`	`/folder/`	`replaceState` → `/folder/index.html`
`/folder/index.html`	`/folder/`	Без изменений

Например, URL-адреса /ru/guide/start/introduction.html и /ru/guide/start/introduction/index.html соответствуют маршруту /ru/guide/start/introduction; итоговый URL будет приведён к формату, заданному параметром cleanUrls, без потери префикса локали.

Форматы канонических URL соответствуют механизму HTML handling в Cloudflare. Однако Cloudflare выполняет HTTP-перенаправления на стороне сервера, тогда как эта опция лишь обновляет URL в адресной строке браузера.

Установите cleanUrlsRedirect в false, чтобы отключить нормализацию URL в браузере.

import { defineConfig } from '@rspress/core';

export default defineConfig({
  route: {
    cleanUrlsRedirect: false,
  },
});

route.localeRedirect

Добавлено в v2.0.19

Тип: 'auto' | 'never' | 'only-default-lang'
По умолчанию: 'auto'

Управляет перенаправлением новых посетителей на ближайшую настроенную локаль на основе window.navigator.language:

auto: Перенаправлять с любой локали на ближайшую настроенную локаль.
never: Отключить автоматические перенаправления на локаль.
only-default-lang: Перенаправлять только при открытии посетителем локали по умолчанию.

Предпочтительны перенаправления на стороне сервера

Этот параметр выполняет перенаправление в браузере. Для рабочих сайтов по возможности рекомендуется обрабатывать определение локали и перенаправления на стороне сервера или на CDN edge. В этом случае посетитель перенаправляется до отправки HTML, и перенаправление не зависит от JavaScript на стороне клиента.

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  route: {
    localeRedirect: 'never',
  },
});

route.useTransitions

Добавлено в v2.0.17

Тип: Boolean
По умолчанию: true

Включает параллельную оптимизированную маршрутизацию для внутренних ссылок, отображаемых стандартным компонентом Link в Rspress. Это относится к ссылкам в содержимом Markdown и MDX, а также к навигационным ссылкам темы по умолчанию, например элементам боковой панели.

По умолчанию этот параметр включён. Переходы между внутренними страницами оборачиваются в React.startTransition, если только вы явно не установите useTransitions в false. Это позволяет избежать блокировки пользовательского ввода во время ресурсоёмкого рендеринга содержимого новой страницы, сохраняя отзывчивость и интерактивность интерфейса при навигации.

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  route: {
    useTransitions: false,
  },
});

route.prefetchLink

Добавлено в v2.0.17

Тип: Boolean
По умолчанию: true

По умолчанию компонент Link в Rspress выполняет предварительную загрузку ресурсов, соответствующих целевому маршруту, когда пользователь наводит курсор на внутреннюю ссылку, а также использует аналогичное поведение на устройствах с сенсорным экраном. Это сделано для повышения производительности. Установите этот параметр в false, чтобы отключить предварительную загрузку.

Совет

В режиме разработки предварительная загрузка ссылок спроектирована для совместной работы с dev.lazyCompilation, который по умолчанию включён в Rspress. Ленивая компиляция ускоряет запуск, компилируя страницы только при первом переходе к ним, а предварительная загрузка ссылок начинает компиляцию целевого маршрута уже при наведении курсора, сокращая время ожидания при первом открытии этой страницы.

Пример:

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  route: {
    prefetchLink: false,
  },
});

ssg

Тип: boolean | { experimentalWorker?: boolean; experimentalLoose?: boolean; }
По умолчанию: true

Управляет тем, включена ли генерация статического сайта. По умолчанию Rspress включает её и генерирует как CSR-, так и SSG-версии сайта.

Если вашему сайту документации требуется только CSR-версия, установите для параметра ssg значение false.

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  ssg: false,
});

Совет

Для SSG требуется, чтобы исходный код был совместим с SSR. Если код несовместим с SSR, сборка завершится с ошибкой. Можно попробовать:

Исправить код, чтобы он стал совместим с SSR.
Установить ssg: false — тогда функция SSG будет отключена.

experimentalWorker

Тип: boolean
По умолчанию: false

При включении Rspress использует воркеры для ускорения SSG и снижения потребления памяти. Это подходит для крупных сайтов документации и основано на tinypool.

experimentalExcludeRoutePaths

Тип: (string | RegExp)[]
По умолчанию: []

Исключает выбранные страницы из SSG, чтобы они использовали CSR-HTML напрямую. Это может помочь крупным сайтам документации обойти ошибки SSG для небольшого количества страниц, однако не рекомендуется использовать это как поведение по умолчанию.

replaceRules

Тип: { search: string | RegExp; replace: string; }[]
По умолчанию: []

С помощью replaceRules можно задать глобальные правила замены текста для всего сайта. Правила применяются ко всем элементам: к файлам _meta.json, к метаданным, к содержимому и заголовкам документов.

rspress.config.ts

export default {
  replaceRules: [
    {
      search: /foo/g,
      replace: 'bar',
    },
  ],
};

languageParity

Тип: Object

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

languageParity.enable

Тип: boolean
По умолчанию: false

Включить проверку паритета языков.

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  languageParity: {
    enabled: true,
  },
});

languageParity.include

Тип: string[]
По умолчанию: []

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

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  languageParity: {
    // папки `posts/foods` и `articles` внутри языковых директорий ru/en
    include: ['posts/foods', 'articles'],
  },
});

languageParity.exclude

Тип: string[]
По умолчанию: []

Исключает определённые папки и файлы из проверки на паритет языков.

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  languageParity: {
    exclude: ['excluded-directory', 'articles/secret.md'],
  },
});

#Базовая конфигурация

#root

#base

#siteOrigin

#title

#description

#icon

#lang

#i18nSourcePath

#i18nSource

#logo

#logoHref

#logoText

#outDir

#themeDir

#locales

#head

#globalStyles

#llms

#mediumZoom

#search

#searchHooks

#versioned

#codeBlocks

#globalUIComponents

#multiVersion

#route

#route.include

#route.exclude

#route.excludeConvention

#route.extensions

#route.cleanUrls

#route.cleanUrlsRedirect

#При cleanUrls: true

#При cleanUrls: false

#route.localeRedirect

#route.useTransitions

#route.prefetchLink

#ssg

#experimentalWorker

#experimentalExcludeRoutePaths

#replaceRules

#languageParity

#languageParity.enable

#languageParity.include

#languageParity.exclude

Базовая конфигурация

root

base

siteOrigin

title

description

icon

lang

i18nSourcePath

i18nSource

logo

logoHref

logoText

outDir

themeDir

locales

head

globalStyles

llms

mediumZoom

search

searchHooks

versioned

codeBlocks

globalUIComponents

multiVersion

route

route.include

route.exclude

route.excludeConvention

route.extensions

route.cleanUrls

route.cleanUrlsRedirect

При `cleanUrls: true`

При `cleanUrls: false`

route.localeRedirect

route.useTransitions

route.prefetchLink

ssg

experimentalWorker

experimentalExcludeRoutePaths

replaceRules

languageParity

languageParity.enable

languageParity.include

languageParity.exclude