2026-04-20 06:40:34 +03:00
|
|
|
|
# Style Guide
|
|
|
|
|
|
|
|
|
|
|
|
Репозиторий с правилами и стандартами фронтенд-разработки. Исходники документации собираются в разные форматы под разные фреймворки.
|
|
|
|
|
|
|
|
|
|
|
|
## Структура
|
|
|
|
|
|
|
|
|
|
|
|
```text
|
|
|
|
|
|
src/ # Исходники — только .md файлы
|
|
|
|
|
|
├── base/ # Общие правила (не поставляется отдельно)
|
|
|
|
|
|
│ ├── basics/ # Базовые: стиль кода, именование, типизация
|
|
|
|
|
|
│ ├── applied/ # Прикладные: компоненты, стили, хуки, API
|
|
|
|
|
|
│ └── triggers/ # Триггеры: создание компонента, стилизация и т.д.
|
|
|
|
|
|
│
|
|
|
|
|
|
└── nextjs/ # Next.js — самостоятельная единица
|
|
|
|
|
|
├── applied/ # Next.js-специфичные: page-level, project-structure
|
|
|
|
|
|
├── triggers/ # Next.js-специфичные триггеры: create-page, create-layout
|
|
|
|
|
|
├── DEVELOP.md # Точка входа для агента-разработчика
|
|
|
|
|
|
└── REVIEW.md # Точка входа для агента-ревьювера
|
|
|
|
|
|
|
|
|
|
|
|
scripts/ # Скрипты и манифесты сборки
|
|
|
|
|
|
├── build-ai.js # Скрипт сборки
|
|
|
|
|
|
└── nextjs.build.js # Манифест: какие файлы, куда, как называются
|
|
|
|
|
|
|
|
|
|
|
|
dist/ # Собранные версии (gitignore)
|
|
|
|
|
|
├── ai/{framework}/ # Для AI-агентов
|
|
|
|
|
|
└── vitepress/{framework}/ # Для людей (планируется)
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## Сборка
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
npm run build:ai # Собрать все фреймворки
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## Манифест
|
|
|
|
|
|
|
|
|
|
|
|
Каждый фреймворк имеет манифест `scripts/{framework}.build.js`. Ключ — путь в выходной папке, значение — путь исходника в `src/`.
|
|
|
|
|
|
|
|
|
|
|
|
Скрипт только копирует файлы по манифесту. Никакой генерации.
|
|
|
|
|
|
|
|
|
|
|
|
## Добавление раздела
|
|
|
|
|
|
|
|
|
|
|
|
1. Создать `.md` в `src/base/` (общий) или `src/{framework}/` (специфичный).
|
|
|
|
|
|
2. Добавить frontmatter: `title`, `scope`, `keywords`, `when`.
|
|
|
|
|
|
3. Добавить путь в манифест `scripts/{framework}.build.js`.
|
|
|
|
|
|
4. Обновить точку входа (`DEVELOP.md` и/или `REVIEW.md`).
|
|
|
|
|
|
5. `npm run build:ai`.
|
|
|
|
|
|
|
|
|
|
|
|
## Добавление фреймворка
|
|
|
|
|
|
|
|
|
|
|
|
1. Создать `src/{framework}/` с `.md` файлами и точками входа.
|
|
|
|
|
|
2. Создать `scripts/{framework}.build.js`.
|
|
|
|
|
|
3. `npm run build:ai`.
|
