# dedonych/shikimori-dark-theme architecture

> Architecture diagram of the GitHub repository dedonych/shikimori-dark-theme, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-02-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dedonych/shikimori-dark-theme
- Repository: https://github.com/dedonych/shikimori-dark-theme

## Overview

##### Тип проекта и назначение (что рисуем)
По дереву и README это **не “сервис” и не backend**, а **пакет клиентской кастомизации UI** для сайта *shikimori.one*:

- Основной артефакт: **SCSS/CSS “Dark Theme”** (исходник `shikimori_dark.scss`, сборка в `dist/…min.css`).
- Доп. инструмент: **`colorpicker.js`** — пользовательский скрипт (Tampermonkey/консоль), который помогает подбирать и применять CSS-переменные (`--my-clr`, `--dropdown`) и копировать готовые строки.

Следовательно, “системная архитектура” здесь — это **архитектура распространения и применения темы в браузере**, плюс **пайплайн сборки SCSS→CSS** (даже если инструменты сборки не закоммичены, на диаграмме нужно отразить факт существования сборки `dist` из `scss`).

##### Разбор структуры репозитория (компоненты для диаграммы)
Отразите в диаграмме как минимум такие узлы (каждый — отдельным блоком):

##### Исходники
- `shikimori_dark.scss` — единый/главный исходный стиль темы. В README есть ссылка на участок, где переменные переносятся в `body` (значит важно отметить: **кастомизация завязана на CSS Custom Properties** и scope `:root`/`body`).
- `colorpicker.js` — самостоятельный инструмент, который:
- меняет `--my-clr`, `--dropdown`
- “lock/unlock”, swap, random, копирование строк, reset
- живёт как **userscript** (Tampermonkey) или выполняется в консоли.

##### Сборка/артефакты
- `dist/` — **публично подключаемый CSS** (в README импорт через raw GitHub URL).
- Важно на диаграмме указать: dist — это “release artifact / compiled CSS”.

##### Документация/ассеты
- `README.md` — инструкция подключения, список фич, праздничные темы (условная активация через CSS-переменные).
- `posters/`, `posters/features/` — скриншоты для документации.

##### Что важно вытащить из README для архитектуры
README говорит о реальных “точках интеграции”:

1) **Подключение темы**: через CSS `@import url(…/dist/shikimori_dark.min.css)` в пользовательский стиль (скорее Stylus/расширение/собственный CSS на сайте).
##### Настройка через `:root`
- `--my-clr` (основной цвет)
- `--dropdown` (цвет верхнего меню)
- `--news:none`, отключение подсказки
- флаги праздничных тем: `--themes:none`, `--xmas:none`, `--halloween:none`, `--fools:none`
3) **Праздничные темы**: логика включения/отключения не кодом, а **через CSS-переменные**, и вероятно привязана к календарным датам (то есть в CSS есть правила, условно активирующие оформление в определённые дни).
4) **ColorPicker JS**: отдельный путь настройки — динамически меняет CSS variables в рантайме и помогает копировать настройки.

##### 4a) Главные компоненты (что обязано быть на диаграмме)
Разбейте на 3 “плоскости”:

**A. Репозиторий / разработка**
- Developer
- `shikimori_dark.scss` (source)
- Build step “SCSS → CSS” (инструмент можно обозначить абстрактно: Sass compiler)
- `dist/shikimori_dark.min.css` (artifact)

**B. Доставка/хостинг**
- GitHub repository (source)
- GitHub Raw / CDN-like URL (как источник импорта CSS)

**C. Клиент (браузер пользователя на shikimori.one)**
- Browser
- shikimori.one (как “existing website / DOM”)
- User style manager (Stylus/Custom CSS) — точка, где пользователь вставляет `@import` и `:root` variables
- Theme CSS (загруженный из dist)
- CSS Variables configuration (`:root`, `body`)
- Optional: Tampermonkey + `colorpicker.js` (userscript), который меняет переменные

##### 4b) Связи и взаимодействия (стрелки)
Нарисуйте направленные стрелки с подписями:

##### Theme CSS → shikimori.one DOM: “переписывание/override стилей сайта”
7) **Tampermonkey/Console → `colorpicker.js` → CSS Variables**: “runtime изменение `--my-clr` / `--dropdown`”

##### 4c) Архитектурные принципы/паттерны (что подчеркнуть)
- **Configuration via CSS Custom Properties**: ключевая точка расширяемости — не форкать тему, а менять переменные.
- **Runtime theming**: `colorpicker.js` не пересобирает CSS, а меняет переменные на лету.
- **Separation of concerns**:
- SCSS — “источник истины”
- dist — “дистрибутив”
- README/posters — “документация/маркетинг”
- **External dependency**: сайт shikimori.one — внешний, не контролируется проектом; тема “накладывается” поверх существующих классов/DOM.

##### 4d) Технологии (подписи на блоках)
- SCSS/Sass
- CSS Custom Properties (`:root`, `body`, `--my-clr`, `--dropdown`)
- GitHub Raw URL как хостинг артефакта
- Userscript (Tampermonkey) / DevTools Console
- Browser rendering pipeline (можно кратко: “CSS cascade/override”)

##### Как адаптировать диаграмму под этот тип проекта (тема/пользовательский стиль)
Для темы правильнее делать **две диаграммы** (или одну, но с двумя зонами):

##### Диаграмма 1: “Build & Release”
Цель — показать откуда берётся `dist`:
- `shikimori_dark.scss` → (Sass compiler) → `dist/shikimori_dark.min.css` → GitHub

Даже если в репозитории нет `package.json`/скриптов, блок “Sass compiler” всё равно нужен, иначе непонятно происхождение `dist`.

##### Диаграмма 2: “Runtime / Integration”
Цель — показать как пользователь реально использует:
- Пользователь → добавляет `@import` и `:root` переменные → браузер грузит CSS → применяется к DOM shikimori.one
- Опционально: `colorpicker.js` → меняет CSS variables → UI меняется мгновенно

##### Что обязательно включить в сам рисунок (оформление)
Чтобы диаграмма была “principal-grade” и при этом максимально понятной:

- **Чёткие лейблы**:
- “Source SCSS”, “Compiled CSS (dist)”, “GitHub Raw URL”, “User Style (Stylus)”, “Tampermonkey userscript”, “CSS variables (:root/body)”, “shikimori.one DOM”.
- **Стрелки с глаголами** (не просто линии):
- “compile”, “publish”, “import”, “override styles”, “set variables”, “mutate variables at runtime”.
- **Цвет/формы по типам**:
- Код/артефакты (файлы) — прямоугольники
- Процессы (компиляция) — ромб/скруглённый прямоугольник
- Внешние системы (shikimori.one, GitHub Raw) — отдельный цвет/рамка “external”
- Клиентские инструменты (Stylus/Tampermonkey) — отдельная группа “Browser Extensions”

##### “Не переусложнять, но максимально разложить на компоненты”
Самая точная декомпозиция для этого репозитория — это:

- **Theme Source**: `shikimori_dark.scss`
- **Theme Distribution**: `dist/shikimori_dark.min.css` (и канал доставки через raw)
- **Configuration Surface**: `:root`/`body` variables (`--my-clr`, `--dropdown`, флаги отключения тем)
- **Runtime Tooling**: `colorpicker.js` (userscript/console)
- **Target System**: shikimori.one DOM/CSS (external)

Если изобразить эти 6 блоков и их стрелочные связи — это будет “лучшее и самое точное” архитектурное представление для данного проекта.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% =========================
    %% BUILD & RELEASE (vertical)
    %% =========================
    subgraph "Build & Release (Repo → dist)"
        direction TB

        Dev["Developer"]:::actor

        subgraph "Repository (GitHub)"
            direction TB
            Readme["README (Integration guide)"]:::doc
            Scss["Theme Source SCSS\nshikimori_dark.scss"]:::code
            AssetsPosters["Posters (Screenshots)\nposters/"]:::asset
            AssetsFeatures["Feature Posters\nposters/features/"]:::asset
            AssetsIcons["Icons\nicons/"]:::asset
            Dist["Theme Distribution (Compiled CSS)\ndist/"]:::artifact
        end

        BuildProc{"Build Step\nSass compiler\n(SCSS → minified CSS)"}:::process

        Raw["GitHub Raw URL\n(CDN-like delivery)"]:::external

        Dev -->|"edit_theme"| Scss
        Scss -->|"compile_and_minify"| BuildProc
        BuildProc -->|"emit_release_artifact"| Dist
        Dist -->|"publish"| Raw

        Readme -.->|"documents_import_and_vars"| Dist
        AssetsPosters -.->|"used_in_docs"| Readme
        AssetsFeatures -.->|"used_in_docs"| Readme
        AssetsIcons -.->|"used_in_docs"| Readme
    end

    %% =========================
    %% RUNTIME / INTEGRATION
    %% =========================
    subgraph "Runtime / Integration (Browser on shikimori.one)"
        direction TB

        Browser["User Browser"]:::client

        subgraph "Browser Tools / Extensions"
            direction TB
            Stylus["User Style Manager\n(Stylus / Custom CSS)"]:::tool
            TM["Tampermonkey / DevTools Console"]:::tool
        end

        Vars["CSS Variables Config\n(:root / body)\n--my-clr, --dropdown,\n--news, --themes, --xmas,\n--halloween, --fools"]:::config

        ThemeCSS["Loaded Theme CSS\n(from dist)"]:::artifact

        Derived["Derived Colors\n(e.g., color-mix())"]:::process

        Site["shikimori.one\n(External Website DOM/CSS)"]:::external

        Browser -->|"user_installs_and_runs"| Stylus
        Stylus -->|"@import_load_css"| Raw
        Raw -->|"download_css"| ThemeCSS

        Stylus -->|"set_custom_properties"| Vars
        Vars -->|"parameterize_theme"| ThemeCSS

        ThemeCSS -->|"compute_dependent_colors"| Derived
        Vars -->|"inputs"| Derived
        Derived -->|"feeds_variables_into_rules"| ThemeCSS

        ThemeCSS -->|"override_styles_via_cascade"| Site
        Browser -->|"renders"| Site

        TM -->|"exec_userscript"| CP["Runtime Tooling\ncolorpicker.js"]:::tool
        CP -->|"mutate_variables_runtime\n(--my-clr,--dropdown)"| Vars
    end

    %% =========================
    %% Click events (from mapping)
    %% =========================
    click Scss "https://github.com/dedonych/shikimori-dark-theme/blob/master/shikimori_dark.scss"
    click CP "https://github.com/dedonych/shikimori-dark-theme/blob/master/colorpicker.js"
    click Dist "https://github.com/dedonych/shikimori-dark-theme/tree/master/dist/"
    click Readme "https://github.com/dedonych/shikimori-dark-theme/blob/master/README.md"
    click AssetsPosters "https://github.com/dedonych/shikimori-dark-theme/tree/master/posters/"
    click AssetsFeatures "https://github.com/dedonych/shikimori-dark-theme/tree/master/posters/features/"
    click AssetsIcons "https://github.com/dedonych/shikimori-dark-theme/tree/master/icons/"

    %% =========================
    %% Styles (color is critical)
    %% =========================
    classDef actor fill:#1f2937,stroke:#0b1220,color:#ffffff,stroke-width:1.5px
    classDef code fill:#0ea5e9,stroke:#075985,color:#05212e,stroke-width:1.5px
    classDef artifact fill:#a7f3d0,stroke:#059669,color:#063b2b,stroke-width:1.5px
    classDef process fill:#fde68a,stroke:#b45309,color:#3b2206,stroke-width:1.5px
    classDef doc fill:#e9d5ff,stroke:#7c3aed,color:#2b0b4a,stroke-width:1.5px
    classDef asset fill:#fecaca,stroke:#ef4444,color:#3f0a0a,stroke-width:1.5px
    classDef external fill:#e5e7eb,stroke:#6b7280,color:#111827,stroke-width:1.5px,stroke-dasharray: 4 3
    classDef client fill:#bfdbfe,stroke:#2563eb,color:#0b2457,stroke-width:1.5px
    classDef tool fill:#99f6e4,stroke:#0f766e,color:#042f2e,stroke-width:1.5px
    classDef config fill:#fbcfe8,stroke:#db2777,color:#3a0b20,stroke-width:1.5px
```
