From 80ebd1809924f9a58aaf2ec37a8fa41e8f816377 Mon Sep 17 00:00:00 2001 From: Arswarog Date: Wed, 17 Jun 2026 18:10:08 +0300 Subject: [PATCH] =?UTF-8?q?claude:=20=D0=B8=D0=BD=D0=B8=D1=86=D0=B8=D0=B0?= =?UTF-8?q?=D0=BB=D0=B8=D0=B7=D0=B0=D1=86=D0=B8=D1=8F=20Claude?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CLAUDE.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..deb62e0 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,45 @@ +# 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 + +- `npm start` — dev-сервер +- `npm run build` — production-сборка в `build/` +- `npm run typecheck` — проверка типов (tsc) +- `npm run prettier:check` — проверка форматирования +- `npm run 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`