- Добавлен раздел «Данные»: REST (автоматическая и ручная генерация клиентов, получение данных в server и client компонентах с инкапсуляцией SWR в хуках), Realtime, введение - Прикладные разделы переименованы в «Использование», папка перенесена в `docs/docs/usage/` - Создана группа «Установка и настройка» с папкой `docs/docs/setup/` — туда вынесены PostCSS, Biome, VS Code, алиасы и установка SVG-спрайтов - Подгруппы «Стили» и «SVG-спрайты» в сайдбаре упразднены — страницы установки и использования разнесены по верхнеуровневым группам - Удалён устаревший раздел `applied/api.md` - Перекрёстные ссылки в workflow-разделах и внутри новых страниц синхронизированы с новыми путями - CONTRIBUTING.md обновлён под новую структуру папок
141 lines
6.4 KiB
TypeScript
141 lines
6.4 KiB
TypeScript
import { defineConfig } from 'vitepress';
|
||
|
||
const sidebar = [
|
||
{
|
||
text: 'Главная',
|
||
link: '/docs/',
|
||
},
|
||
{
|
||
text: 'Workflow',
|
||
link: '/docs/workflow',
|
||
},
|
||
{
|
||
text: 'Базовые правила',
|
||
items: [
|
||
{ text: 'Технологии и библиотеки', link: '/docs/basics/tech-stack' },
|
||
{ text: 'Именование', link: '/docs/basics/naming' },
|
||
{
|
||
text: 'Архитектура',
|
||
collapsed: true,
|
||
items: [
|
||
{ text: 'Обзор', link: '/docs/basics/architecture/' },
|
||
{ text: 'Слои', link: '/docs/basics/architecture/reference/layers' },
|
||
{ text: 'Модули', link: '/docs/basics/architecture/reference/modules' },
|
||
{ text: 'Сегменты', link: '/docs/basics/architecture/reference/segments' },
|
||
],
|
||
},
|
||
{ text: 'Стиль кода', link: '/docs/basics/code-style' },
|
||
{ text: 'Документирование', link: '/docs/basics/documentation' },
|
||
{ text: 'Типизация', link: '/docs/basics/typing' },
|
||
],
|
||
},
|
||
{
|
||
text: 'Установка и настройка',
|
||
items: [
|
||
{ text: 'Алиасы', link: '/docs/setup/aliases' },
|
||
{ text: 'Biome', link: '/docs/setup/biome' },
|
||
{ text: 'PostCSS', link: '/docs/setup/postcss' },
|
||
{ text: 'SVG-спрайты', link: '/docs/setup/svg-sprites' },
|
||
{ text: 'VS Code', link: '/docs/setup/vscode' },
|
||
],
|
||
},
|
||
{
|
||
text: 'Использование',
|
||
items: [
|
||
{ text: 'Структура проекта', link: '/docs/usage/project-structure' },
|
||
{ text: 'Компоненты', link: '/docs/usage/components' },
|
||
{ text: 'Страницы (App Router)', link: '/docs/usage/page-level' },
|
||
{ text: 'Шаблоны и генерация кода', link: '/docs/usage/templates-generation' },
|
||
{ text: 'Стили', link: '/docs/usage/styles' },
|
||
{ text: 'Изображения', link: '/docs/usage/images-sprites' },
|
||
{ text: 'SVG-спрайты', link: '/docs/usage/svg-sprites' },
|
||
{ text: 'Видео', link: '/docs/usage/video' },
|
||
{
|
||
text: 'Данные',
|
||
collapsed: true,
|
||
items: [
|
||
{ text: 'Введение', link: '/docs/usage/data/' },
|
||
{
|
||
text: 'REST',
|
||
collapsed: true,
|
||
items: [
|
||
{
|
||
text: 'Клиенты',
|
||
collapsed: true,
|
||
items: [
|
||
{ text: 'Автоматическая генерация', link: '/docs/usage/data/rest/clients/auto' },
|
||
{ text: 'Ручная генерация', link: '/docs/usage/data/rest/clients/manual' },
|
||
],
|
||
},
|
||
{
|
||
text: 'Получение данных',
|
||
collapsed: true,
|
||
items: [
|
||
{ text: 'Серверные компоненты', link: '/docs/usage/data/rest/fetching/server' },
|
||
{ text: 'Клиентские компоненты', link: '/docs/usage/data/rest/fetching/client' },
|
||
],
|
||
},
|
||
],
|
||
},
|
||
{ text: 'Realtime', link: '/docs/usage/data/realtime' },
|
||
],
|
||
},
|
||
{ text: 'Stores', link: '/docs/usage/stores' },
|
||
{ text: 'Хуки', link: '/docs/usage/hooks' },
|
||
{ text: 'Шрифты', link: '/docs/usage/fonts' },
|
||
{ text: 'Локализация', link: '/docs/usage/localization' },
|
||
],
|
||
},
|
||
|
||
];
|
||
|
||
/**
|
||
* Vite-плагин: отдаёт `.txt` и `.md` с явной кодировкой UTF-8.
|
||
* Без этого браузер декодирует как ISO-8859-1 и кириллица ломается.
|
||
*/
|
||
const utf8TextPlugin = {
|
||
name: 'utf8-text-files',
|
||
configureServer(server: any) {
|
||
server.middlewares.use((req: any, res: any, next: any) => {
|
||
const url: string = req.url || '';
|
||
if (url.endsWith('.txt') || url.endsWith('.md')) {
|
||
res.setHeader('Content-Type', 'text/plain; charset=utf-8');
|
||
}
|
||
next();
|
||
});
|
||
},
|
||
};
|
||
|
||
export default defineConfig({
|
||
srcDir: 'docs',
|
||
// `docs/public/` содержит сгенерированные `.md`-копии и `llms.txt` для LLM
|
||
// (попадают в корень `dist/` как статика). Исключаем из сканирования
|
||
// страниц, иначе VitePress рендерит их как HTML-страницы.
|
||
srcExclude: ['public/**'],
|
||
lang: 'ru-RU',
|
||
title: 'NextJS Style Guide',
|
||
description: 'Стандарты разработки на Next.js + TypeScript с архитектурой SLM',
|
||
|
||
vite: {
|
||
plugins: [utf8TextPlugin],
|
||
define: {
|
||
__BUILD_VERSION__: JSON.stringify(process.env.BUILD_VERSION || 'dev'),
|
||
},
|
||
},
|
||
|
||
themeConfig: {
|
||
sidebar,
|
||
socialLinks: [
|
||
{ icon: 'github', link: 'https://gromlab.ru/docs/nextjs-style-guide' },
|
||
],
|
||
},
|
||
|
||
// Расширенный блок описания для llms.txt — даёт LLM полный
|
||
// технический контекст: стек, методология, охват тем.
|
||
// Используется в generate-llms.ts.
|
||
llmsBlockquote:
|
||
'Стандарты разработки frontend-приложений на Next.js (App Router) + TypeScript + React с архитектурой SLM (Scoped Layered Module Design — модульная архитектура со слоями ответственности, где каждый модуль содержит всё необходимое: компоненты, хуки, сторы, типы, стили).',
|
||
llmsContext:
|
||
'Стек: React, TypeScript, Next.js App Router, Mantine UI, SWR, Zustand, i18next, PostCSS Modules, Vitest, clsx.\n\nДокументация покрывает архитектуру SLM (слои, модули, сегменты, направление зависимостей, публичный API), правила оформления кода (именование, форматирование, импорты, типизация, JSDoc), реализацию компонентов и хуков, работу с App Router, кодогенерацию из шаблонов, стилизацию (Mobile First, токены), работу с API и сокетами, управление состоянием через Zustand, локализацию, ассеты (шрифты, изображения, SVG-спрайты) и настройку VS Code.',
|
||
} as any);
|