Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
104 commits
Select commit Hold shift + click to select a range
a3e8556
Update i18n.json
dragomano Nov 21, 2025
583fc2a
Update rspress.config.ts
dragomano Nov 21, 2025
7343499
Update tsconfig.json
dragomano Nov 21, 2025
aa36f97
Add ru/_nav.json
dragomano Nov 21, 2025
41bbd91
Add ru/index.md
dragomano Nov 21, 2025
da450b0
Add ru/guide/start/introduction.mdx
dragomano Nov 21, 2025
d373862
Add ru/guide/start/getting-started.mdx
dragomano Nov 21, 2025
a1c969c
Add ru/guide/basic/conventional-route.mdx
dragomano Nov 22, 2025
c61eaf9
Add ru/guide/basic/auto-nav-sidebar.mdx
dragomano Nov 22, 2025
72e4295
Add ru/guide/basic/static-assets.mdx
dragomano Nov 22, 2025
73d2e64
Add ru/guide/basic/custom-page.mdx
dragomano Nov 22, 2025
d90b115
Add ru/fragments/global-ui-components.mdx
dragomano Nov 22, 2025
0c3f7b5
Add ru/fragments/page-type.mdx
dragomano Nov 22, 2025
2af6593
Add some _meta.json files
dragomano Nov 22, 2025
234eee6
Add ru/fragments/useI18n.mdx
dragomano Nov 22, 2025
f8b7ecd
Add ru/fragments/mdx-rs.mdx
dragomano Nov 22, 2025
4fff2c2
Add ru/guide/basic/deploy.mdx
dragomano Nov 22, 2025
550909c
Add ru/guide/basic/ssg.mdx
dragomano Nov 22, 2025
99540c0
Add ru/fragments/builtin-components.mdx
dragomano Nov 23, 2025
0b3380e
Add ru/api/client-api/api-components.mdx
dragomano Nov 23, 2025
21e4342
Add ru/api/index.mdx
dragomano Nov 23, 2025
4533415
Add ru/_nav.json
dragomano Nov 23, 2025
49c7b42
Update theme/index.tsx
dragomano Nov 23, 2025
3f31def
Add ru/api/_meta.json
dragomano Nov 23, 2025
0fc7ec6
Update ru/api/_meta.json
dragomano Nov 24, 2025
d00a0b7
Add ru/guide/default-theme/i18n.mdx
dragomano Nov 24, 2025
dda6c32
Add ru/guide/_meta.json
dragomano Nov 24, 2025
f4eb7e7
Add ru/ui/_meta.json
dragomano Nov 24, 2025
f804783
Add ru/guide/default-theme/navbar.mdx
dragomano Nov 24, 2025
ff6aad6
Add ru/guide/default-theme/home-page.mdx
dragomano Nov 24, 2025
6bdb555
Add ru/guide/default-theme/doc-page.mdx
dragomano Nov 24, 2025
fffc6ea
Add ru/guide/default-theme/overview-page.mdx
dragomano Nov 24, 2025
9476c21
Add ru/guide/default-theme/components.mdx
dragomano Nov 24, 2025
90a06ff
Add ru/guide/default-theme/multi-version.mdx
dragomano Nov 24, 2025
44159ac
Add ru/guide/advanced/extend-build.mdx
dragomano Nov 25, 2025
eef29a3
Add ru/guide/advanced/custom-search.mdx
dragomano Nov 25, 2025
3481035
Add ru/guide/use-mdx/_button.mdx
dragomano Nov 26, 2025
a34db64
Add ru/guide/use-mdx/_escape-hatch.tsx
dragomano Nov 26, 2025
c0d249d
Add ru/guide/use-mdx/_mdx-fragment.mdx
dragomano Nov 26, 2025
d223f62
Add ru/guide/use-mdx/frontmatter.mdx
dragomano Nov 26, 2025
b87ed80
Add ru/guide/use-mdx/_tsx-component.tsx
dragomano Nov 26, 2025
82e3006
Update ru/guide/use-mdx/_escape-hatch.tsx
dragomano Nov 26, 2025
25a4256
Update ru/guide/_meta.json
dragomano Nov 26, 2025
afcd069
Add ru/guide/use-mdx/components.mdx
dragomano Nov 26, 2025
28e1044
Add ru/guide/use-mdx/container.mdx
dragomano Nov 26, 2025
d5b42d9
Update some translations
dragomano Nov 27, 2025
f53d645
Add ru/guide/use-mdx/link.mdx
dragomano Nov 27, 2025
bea4893
Add ru/guide/use-mdx/code-blocks.mdx
dragomano Nov 27, 2025
a4ab610
Add ru/guide/use-mdx/_Border.tsx
dragomano Nov 27, 2025
77f99ee
Add ru/plugin/community-plugins/overview.mdx
dragomano Nov 27, 2025
96d8a6c
Add ru/plugin/official-plugins/algolia.mdx
dragomano Nov 27, 2025
f5705df
Add some _meta.json files
dragomano Nov 27, 2025
280fd96
Add ru/plugin/official-plugins/api-docgen.mdx
dragomano Nov 27, 2025
488320d
Add ru/ui/hooks/use-i18n.mdx
dragomano Nov 27, 2025
88406b7
Add ru/plugins/system/introduction.mdx
dragomano Nov 28, 2025
3608f64
Add ru/plugin/system/write-a-plugin.mdx
dragomano Nov 28, 2025
39680f8
Add ru/plugin/official-plugins/overview.mdx
dragomano Nov 28, 2025
4438a69
Add ru/plugin/system/plugin-api.mdx
dragomano Nov 28, 2025
fa32a70
Add ru/plugin/official-plugins/medium-zoom.mdx
dragomano Nov 28, 2025
f8b6669
Add ru/plugin/official-plugins/client-redirects.mdx
dragomano Nov 28, 2025
05fd3e3
Add ru/plugin/official-plugins/last-updated.mdx
dragomano Nov 28, 2025
9911e4a
Add ru/plugin/official-plugins/llms.mdx
dragomano Nov 28, 2025
128d1db
Update DEFAULT_I18N_TEXT.ts
dragomano Nov 28, 2025
182837f
Add ru/plugin/official-plugins/typedoc.mdx
dragomano Nov 29, 2025
fc083a7
Add ru/plugin/official-plugins/twoslash.mdx
dragomano Nov 29, 2025
725cc5b
Update some translations
dragomano Nov 29, 2025
28d591a
Add ru/plugin/official-plugins/sitemap.mdx
dragomano Nov 29, 2025
93ef209
Add ru/plugin/official-plugins/rss.mdx
dragomano Nov 29, 2025
2d23460
Add ru/plugin/official-plugins/preview.mdx
dragomano Nov 29, 2025
856cfc1
Add ru/plugin/official-plugins/playground.mdx
dragomano Nov 29, 2025
d2877f3
Add ru/api/commands.mdx
dragomano Nov 30, 2025
4cde0f7
Add ru/api/config/config-basic.mdx
dragomano Nov 30, 2025
b01cd91
Add ru/api/config/config-theme.mdx
dragomano Nov 30, 2025
ec316b2
Add ru/api/config/config-frontmatter.mdx
dragomano Nov 30, 2025
3e40502
Update some translations
dragomano Nov 30, 2025
b21bc7c
Add ru/api/config/config-build.mdx
dragomano Nov 30, 2025
c0ff3c8
Add ru/api/client-api/api-runtime.mdx
dragomano Dec 1, 2025
b057157
Add ru/ui/vars.mdx
dragomano Dec 1, 2025
4063e5e
Add ru/ui/custom-theme.mdx
dragomano Dec 1, 2025
2c63bb7
Add ru/ui/components/page-tabs.mdx
dragomano Dec 1, 2025
f1abc35
Merge branch 'main' into russian
dragomano Dec 1, 2025
0d7651e
Update some translations
dragomano Dec 1, 2025
ed2304e
Fix some links
dragomano Dec 1, 2025
176edb9
Add ru/plugin/official-plugins/_demo.tsx
dragomano Dec 1, 2025
8012846
Update ru/plugin/official-plugins/preview.mdx
dragomano Dec 1, 2025
f87fede
Merge branch 'main' into russian
dragomano Dec 2, 2025
79b7445
Update ru/plugin/official-plugins/llms.mdx
dragomano Dec 3, 2025
7ddb235
Merge branch 'main' into russian
dragomano Dec 4, 2025
8566948
Update ru/plugin/official-plugins/llms.mdx
dragomano Dec 4, 2025
8229780
Merge branch 'main' into russian
dragomano Dec 6, 2025
b4f100c
Update ru/guide/use-mdx/code-blocks.mdx
dragomano Dec 6, 2025
44ca1f8
Update ru/plugin/official-plugins/algolia.mdx
dragomano Dec 6, 2025
8dfac16
Update ru/plugin/official-plugins/llms.mdx
dragomano Dec 6, 2025
5f846cd
Merge branch 'web-infra-dev:main' into russian
dragomano Dec 8, 2025
e81c5ce
Update ru/fragments/builtin-components.mdx
dragomano Dec 8, 2025
65cf32d
Update ru/plugin/official-plugins/algolia.mdx
dragomano Dec 8, 2025
2b0b847
Update ru/plugin/official-plugins/llms.mdx
dragomano Dec 8, 2025
0ef4530
Update ru/plugin/official-plugins/sitemap.mdx
dragomano Dec 8, 2025
930e870
Update ru/plugin/official-plugins/twoslash.mdx
dragomano Dec 8, 2025
b4947ee
Update ru/plugin/official-plugins/typedoc.mdx
dragomano Dec 8, 2025
25e5cb8
Update ru/ui/custom-theme.mdx
dragomano Dec 8, 2025
e76b2a0
Update packages/plugin-algolia/src/runtime/index.ts
dragomano Dec 8, 2025
a4045b9
Update ru/plugin/official-plugins/algolia.mdx
dragomano Dec 8, 2025
82f93ec
Update theme/index.tsx
dragomano Dec 8, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/plugin-algolia/src/runtime/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
export { type Locales, ZH_LOCALES } from './locales';
export { type Locales, RU_LOCALES, ZH_LOCALES } from './locales';
export { Search, type SearchProps } from './Search';
36 changes: 36 additions & 0 deletions website/docs/ru/_nav.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[
{
"text": "Руководство",
"link": "/guide/start/introduction",
"activeMatch": "/guide/"
},
{
"text": "Плагины",
"link": "/plugin/system/introduction",
"activeMatch": "/plugin/"
},
{
"text": "UI",
"link": "/ui/vars",
"activeMatch": "/ui/",
"tag": "новинка"
},
{
"text": "API",
"link": "/api/",
"activeMatch": "/api/"
},
{
"text": "Версия",
"items": [
{
"text": "Журнал изменений",
"link": "https://github.com/web-infra-dev/rspress/releases"
},
{
"text": "Документация Rspress 1.x",
"link": "http://rspress.rs/"
}
]
}
]
22 changes: 22 additions & 0 deletions website/docs/ru/api/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[
{
"type": "file",
"name": "index",
"label": "apiOverview"
},
{
"type": "dir",
"name": "config",
"label": "config"
},
{
"type": "dir",
"name": "client-api",
"label": "clientApi"
},
{
"type": "file",
"name": "commands",
"label": "commands"
}
]
1 change: 1 addition & 0 deletions website/docs/ru/api/client-api/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["api-runtime", "api-components"]
5 changes: 5 additions & 0 deletions website/docs/ru/api/client-api/api-components.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Встроенные компоненты

import BuiltinComponents from '../../fragments/builtin-components';

<BuiltinComponents />
103 changes: 103 additions & 0 deletions website/docs/ru/api/client-api/api-runtime.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Runtime API

Rspress предоставляет несколько runtime API, которые удобно использовать для реализации собственной логики.

## usePageData

- **Тип:** `() => PageData`

Получает данные текущей страницы. Возвращает объект, содержащий все данные текущей страницы.

```js
import { usePageData } from '@rspress/core/runtime';

function MyComponent() {
const pageData = usePageData();
return <div>{pageData.page.title}</div>;
}
```

## useLang

- **Тип:** `() => string`

Получает текущий язык. Возвращает строку — код текущего языка.

```js
import { useLang } from '@rspress/core/runtime';

function MyComponent() {
const lang = useLang();
// lang === 'ru-RU'
return <div>{lang}</div>;
}
```

## useVersion

- **Тип:** `() => string`

Получает текущую версию. Возвращает строку — текущую версию.

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

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

## useDark

- **Тип:** `() => boolean`

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

```js
import { useDark } from '@rspress/core/runtime';

function MyComponent() {
const dark = useDark();
return <div>{dark}</div>;
}
```

Обратите внимание, что в процессе SSG (статической генерации) хук `useDark` **не может** точно отразить настройку темы браузера пользователя, потому что SSG выполняется на этапе сборки. Только после завершения клиентской гидратации этот хук начнёт возвращать правильное значение темы.

Если вам нужно применить стили тёмной темы уже на этапе SSG, рекомендуется использовать CSS-селектор `.dark`. Rspress добавляет класс `dark` на корневой элемент документа — это работает как при статической генерации, так и на клиенте:

```css
/* Стиль светлой темы */
.my-component {
color: black;
background-color: white;
}

/* Стиль тёмной темы */
.dark .my-component {
color: white;
background-color: #1a1a1a;
}
```

## useI18n

import UseI18n from '../../fragments/useI18n';

<UseI18n />

> Подробнее читайте в разделе [Интернационализация](/guide/default-theme/i18n).

## Хуки маршрутизации

Rspress внутренне использует `react-router-dom` и переэкспортирует все его API. Вы можете пользоваться ими так же, как в обычном React-приложении:

```ts
import { useLocation } from '@rspress/core/runtime';

function MyComponent() {
const location = useLocation();
return <div>{location.pathname}</div>;
}
```
46 changes: 46 additions & 0 deletions website/docs/ru/api/commands.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Команды

В этой главе вы узнаете о встроенных командах Rspress и о том, как их использовать.

## rspress dev

Команда `rspress dev` используется для запуска локального сервера разработки, который предоставляет среду разработки для предварительного просмотра и отладки документации.

```txt
Использование: rspress dev [root] [options]

Опции:
root указать корневую директорию проекта, по умолчанию — `docs` в текущей директории, необязательно
-c --config <config> указать путь к файлу конфигурации, может быть относительным или абсолютным
--port <port> указать номер порта
--host <host> указать хост
-h, --help показать справку по команде
```

## rspress build

Команда `rspress build` используется для сборки сайта документации в продакшен-версии.

```txt
Использование: rspress build [root] [options]

Опции:
root указать корневую директорию проекта, по умолчанию — `docs` в текущей директории, необязательно
-c --config <config> указать путь к файлу конфигурации, может быть относительным или абсолютным
-h, --help показать справку по команде
```

## rspress preview

Команда `rspress preview` используется для локального предварительного просмотра файлов, полученных после выполнения команды `rspress build`.

```txt
Использование: rspress preview [root] [options]

Опции:
root указать корневую директорию проекта, по умолчанию — `docs` в текущей директории, необязательно
-c --config <config> указать путь к файлу конфигурации, может быть относительным или абсолютным
--port <port> указать номер порта
--host <host> указать хост
-h, --help показать справку по команде
```
1 change: 1 addition & 0 deletions website/docs/ru/api/config/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
["config-basic", "config-theme", "config-frontmatter", "config-build"]
Loading
Loading