Style Guide

Репозиторий с правилами и стандартами фронтенд-разработки. Исходники документации собираются в разные форматы под разные фреймворки.

Структура

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}/         # Для людей (планируется)

Сборка

npm run build:ai                   # Собрать все фреймворки

Манифест

Каждый фреймворк имеет манифест scripts/{framework}.build.js. Ключ — путь в выходной папке, значение — путь исходника в src/.

Скрипт только копирует файлы по манифесту. Никакой генерации.

Добавление раздела

Создать .md в src/base/ (общий) или src/{framework}/ (специфичный).
Добавить frontmatter: title, scope, keywords, when.
Добавить путь в манифест scripts/{framework}.build.js.
Обновить точку входа (DEVELOP.md и/или REVIEW.md).
npm run build:ai.

Добавление фреймворка

Создать src/{framework}/ с .md файлами и точками входа.
Создать scripts/{framework}.build.js.
npm run build:ai.

2.9 KiB Raw Permalink Blame History Unescape Escape