0bbea952600692f416d3763450e722e24a47d54c
Код-стайл для фронтенд-проектов на React/NextJS и TypeScript
Этот репозиторий содержит документацию с правилами разработки фронтенд-проектов на React/NextJS и TypeScript.
Как запустить документацию
-
Установите зависимости:
npm install -
Запустите локальный сервер документации:
npm run devДокументация будет доступна по адресу http://localhost:5173
-
Для сборки статики:
npm run build -
Для предпросмотра собранной документации:
npm run serve
Где находятся документы
- Главная страница документации —
index.md. - Основные разделы — в
parts/(каждый раздел — отдельный markdown-файл). - Конфигурация VitePress —
.vitepress/config.ts. README.md— описание проекта и не связан сparts/.
Генерация RULES.md
- Файл
RULES.mdсобирается из содержимогоparts/. - Команда:
npm run docs
Как дополнять документацию
- Добавляйте новые разделы в папку
parts/. - Обновляйте sidebar в
.vitepress/config.tsдля навигации. - Используйте только русский язык.
Description
Languages
TypeScript
60.6%
JavaScript
26.6%
Dockerfile
6.5%
CSS
6.3%