Files
frontend-style-guide/README.md

47 lines
1.6 KiB
Markdown
Raw Normal View History

2026-01-30 02:10:51 +03:00
# Frontend Style Guide для проектов на React/Next.js и TypeScript
2026-01-29 16:00:19 +03:00
Этот репозиторий содержит документацию с правилами разработки фронтенд-проектов на React/NextJS и TypeScript.
## Как запустить документацию
1. Установите зависимости:
```bash
npm install
```
2. Запустите локальный сервер документации:
```bash
npm run dev
```
Документация будет доступна по адресу http://localhost:5173
3. Для сборки статики:
```bash
npm run build
```
4. Для предпросмотра собранной документации:
```bash
npm run serve
```
## Где находятся документы
- Главная страница документации — `index.md`.
- Основные разделы — в `parts/` (каждый раздел — отдельный markdown-файл).
- Конфигурация VitePress — `.vitepress/config.ts`.
- `README.md` — описание проекта и не связан с `parts/`.
2026-01-30 02:02:32 +03:00
## Генерация RULES.md
2026-01-29 16:00:19 +03:00
2026-01-30 02:02:32 +03:00
- Файл `RULES.md` собирается из содержимого `parts/`.
2026-01-29 16:00:19 +03:00
- Команда:
```bash
npm run docs
```
## Как дополнять документацию
- Добавляйте новые разделы в папку `parts/`.
- Обновляйте sidebar в `.vitepress/config.ts` для навигации.
- Используйте только русский язык.