frontend-style-guide/README.md

Код-стайл для фронтенд-проектов на React/NextJS и TypeScript

Этот репозиторий содержит документацию с правилами разработки фронтенд-проектов на React/NextJS и TypeScript.

Как запустить документацию

1. Установите зависимости:

   npm install
   

2. Запустите локальный сервер документации:

   npm run dev
   

   Документация будет доступна по адресу http://localhost:5173

3. Для сборки статики:

   npm run build
   

4. Для предпросмотра собранной документации:

   npm run serve
   

Где находятся документы

• Главная страница документации — index.md.
• Основные разделы — в parts/ (каждый раздел — отдельный markdown-файл).
• Конфигурация VitePress — .vitepress/config.ts.
• README.md — описание проекта и не связан с parts/.

Генерация .cursorrules

• Файл .cursorrules собирается из содержимого parts/.
• Команда:

  npm run docs
  

Как дополнять документацию

• Добавляйте новые разделы в папку parts/.
• Обновляйте sidebar в .vitepress/config.ts для навигации.
• Используйте только русский язык.