arswarog
03f7302317
Reviewed-on: #6 Co-authored-by: Arswarog <arswarog@yandex.ru> Co-committed-by: Arswarog <arswarog@yandex.ru>
48 lines
2.1 KiB
Markdown
48 lines
2.1 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this
|
|
repository.
|
|
|
|
## Project Overview
|
|
|
|
Docuservix docs — шаблон документационного сайта на Docusaurus 3.10 (React 19, TypeScript 6).
|
|
Конфигурация сайта читается из `.docuservix.yml` (title, project.org, project.repo, dirs). Локаль —
|
|
русский (`ru`).
|
|
|
|
## Commands
|
|
|
|
Используется **yarn**.
|
|
|
|
- `yarn start` — dev-сервер
|
|
- `yarn build` — production-сборка в `build/`
|
|
- `yarn typecheck` — проверка типов (tsc)
|
|
- `yarn prettier:check` — проверка форматирования
|
|
- `yarn prettier:fix` — автоформатирование
|
|
|
|
## Architecture
|
|
|
|
- `docusaurus.config.ts` — главный конфиг; читает `.docuservix.yml` через `js-yaml`
|
|
- `src/pages/` — кастомные страницы (index.tsx — главная)
|
|
- `src/css/custom.css` — глобальные CSS-переменные (`--ifm-*`)
|
|
- `docs/` — Markdown/MDX-документация
|
|
- `blog/` — блог (опционально, включается через `dirs.blog` в `.docuservix.yml`)
|
|
- Mermaid-диаграммы включены (`@docusaurus/theme-mermaid`)
|
|
- Docusaurus future v4 compatibility flag включён
|
|
|
|
## Code Style
|
|
|
|
- Prettier: 4 пробела, single quotes, trailing commas, `printWidth: 100`,
|
|
`singleAttributePerLine: true`
|
|
- JSON: `printWidth: 10` (каждое свойство на отдельной строке)
|
|
- Markdown/MDX: `proseWrap: always`
|
|
- Husky + lint-staged: prettier запускается автоматически на pre-commit
|
|
- CSS Modules (`*.module.css`) с camelCase именами классов
|
|
- **Без default export** в shared/UI компонентах; default export допустим только для Docusaurus
|
|
route-компонентов (page components)
|
|
|
|
## Environment
|
|
|
|
- Node >= 20
|
|
- Env vars: `DOCUSERVIX_URL` (production URL), `DOCUSERVIX_ON_BROKEN_LINKS` (override onBrokenLinks)
|
|
- Gitea instance: `git.jt4d.ru`
|