sync
This commit is contained in:
47
README.md
47
README.md
@@ -1,46 +1,13 @@
|
|||||||
# Frontend Style Guide для проектов на React/Next.js и TypeScript
|
# Frontend Style Guide для проектов на React/Next.js и TypeScript
|
||||||
|
|
||||||
Этот репозиторий содержит документацию с правилами разработки фронтенд-проектов на React/NextJS и TypeScript.
|
Это набор правил и практик для разработки фронтенд-проектов: архитектура, типизация, стили, компоненты, API и инфраструктурные разделы.
|
||||||
|
|
||||||
## Как запустить документацию
|
## Как пользоваться
|
||||||
|
|
||||||
1. Установите зависимости:
|
- Начните с «Технологии и библиотеки», чтобы понимать базовые допущения.
|
||||||
```bash
|
- Затем прочитайте разделы из «Базовых правил».
|
||||||
npm install
|
- При реализации используйте соответствующие прикладные разделы.
|
||||||
```
|
|
||||||
2. Запустите локальный сервер документации:
|
|
||||||
```bash
|
|
||||||
npm run dev
|
|
||||||
```
|
|
||||||
Документация будет доступна по адресу http://localhost:5173
|
|
||||||
|
|
||||||
3. Для сборки статики:
|
## Для ассистентов
|
||||||
```bash
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Для предпросмотра собранной документации:
|
Полная документация в одном MD файле: https://gromlab.ru/docs/frontend-style-guide/raw/branch/main/RULES.md
|
||||||
```bash
|
|
||||||
npm run serve
|
|
||||||
```
|
|
||||||
|
|
||||||
## Где находятся документы
|
|
||||||
|
|
||||||
- Главная страница документации — `index.md`.
|
|
||||||
- Основные разделы — в `parts/` (каждый раздел — отдельный markdown-файл).
|
|
||||||
- Конфигурация VitePress — `.vitepress/config.ts`.
|
|
||||||
- `README.md` — описание проекта и не связан с `parts/`.
|
|
||||||
|
|
||||||
## Генерация RULES.md
|
|
||||||
|
|
||||||
- Файл `RULES.md` собирается из содержимого `parts/`.
|
|
||||||
- Команда:
|
|
||||||
```bash
|
|
||||||
npm run docs
|
|
||||||
```
|
|
||||||
|
|
||||||
## Как дополнять документацию
|
|
||||||
|
|
||||||
- Добавляйте новые разделы в папку `parts/`.
|
|
||||||
- Обновляйте sidebar в `.vitepress/config.ts` для навигации.
|
|
||||||
- Используйте только русский язык.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user