#Мультиверсионность

Стандартная тема Rspress поддерживает документацию с несколькими версиями. В этом руководстве показано, как включить и организовать такие версии.

#Настройка multiVersion

Список версий и версия по умолчанию задаются с помощью параметра multiVersion:

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

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

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

#Добавление документов для разных версий

На основе настроенного списка версий добавьте версии документации в директорию docs:

В стандартной маршрутизации Rspress префикс для версии по умолчанию опускается. Например, v1/index.mdx отображается как /, а v2/index.mdx — как /v2/.

#Использование вместе с i18n

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

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

export default defineConfig({
  lang: 'ru',
  locales: [
    {
      lang: 'en',
      label: 'English',
    },
    {
      lang: 'ru',
      label: 'Русский',
    },
  ],
  multiVersion: {
    default: 'v1',
    versions: ['v1', 'v2'],
  },
});

Организуйте директорию docs следующим образом:

Сгенерированные маршруты следуют шаблону /{version}/{lang}/:

#Получение текущей версии в компонентах

В компонентах текущую версию можно получить с помощью useVersion:

import { useVersion } from '@rspress/core/runtime';

export default () => {
  const version = useVersion();
  return <div>Текущая версия: {version}</div>;
};

#Поиск, специфичный для версии

По умолчанию search.versioned установлен в true, что означает, что поиск будет выполняться только по индексу, соответствующему текущей выбранной версии. Если вы хотите выполнять поиск по всем версиям, можно установить значение false:

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

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