# bladeacer/flexcyon architecture

> Architecture diagram of the GitHub repository bladeacer/flexcyon, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-10). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bladeacer/flexcyon
- Repository: https://github.com/bladeacer/flexcyon

## Overview

##### Out the Main Components
- Theme Assets (SCSS):
⁃ Represent the SCSS folder as the heart of the project. Within this, show the subdivisions:
▪ The “modifiers” folder with plugins and snippets that support extra styling options.
▪ The “theme.scss” file which likely acts as the main entry point for compiling the SCSS.
- Manifest & Distribution:
⁃ Include the manifest.json file which defines the theme for Obsidian.
⁃ The generated “theme.css” (or the output after SCSS compilation) should be shown as the final deliverable that Obsidian loads.
- Documentation & Community Integration:
⁃ Add the docs directory that contains changelogs, screenshots, roadmap, and style settings documentation.
⁃ Note the README itself for installation instructions via the Obsidian community store and BRAT.
- Continuous Integration / Version Control:
⁃ Represent the .github directory and workflows (e.g., release.yml) that automate releases and ensure quality control through versioning.
- Integration with Obsidian & Supported Plugins:
⁃ Add a block or node that indicates how the theme integrates with Obsidian’s UI.
⁃ Include external plugins and snippets (like File Tree Alternative, Highlightr, Kanban, etc.) as nodes that interact with the theme’s styling (especially via modifier styles).

##### Component Interactions & Flow
- A “build/compilation” process (even if implicit) that compiles these files into the final theme.css.
- Documentation and style settings to the SCSS assets – these inform end-user customization and plugin integration.
- CI setup (via GitHub workflows) that triggers on code changes and releases the updated theme.

##### Architectural Patterns / Design Principles
- Modular Design: Emphasize that the project uses a modular SCSS structure (with separate partials for foundations, plugins, and snippets) for easier maintenance and extensibility.
- Customizability & Extensibility: Showcase the clear separation between core theme styles and additional modifiers/plugins, which facilitate integration with various Obsidian plugins and optional style overrides.
- Lightweight and Opinionated: Note the design principle of keeping the compiled output efficient (no embedded fonts/svgs) while still offering a “reasonably opinionated” visual style.

## Diagram (Mermaid)

```mermaid
graph TD
    %% Styling Assets Subgraph
    subgraph "Styling Assets"
        SCSS["SCSS Assets"]:::source
        Flexcyon["Core Theme (Flexcyon Modules)"]:::source
        ThemeEntry["Main SCSS Entry Point"]:::source
        Modifiers["Modifiers & Plugins (Extra Styling Options)"]:::source
    end

    %% Documentation Subgraph
    subgraph "Documentation"
        DocDocs["Documentation (docs/)"]:::source
        DocReadme["README (README.md)"]:::source
    end

    %% Process and Integration Nodes
    CI_CD["CI/CD Pipeline (.github workflows)"]:::process
    BuildProcess["Build/Compilation Process"]:::process
    ManifestDist["Manifest & Distribution Configuration"]:::output
    FinalOutput["Compiled Final Output (theme.css)"]:::output
    Obsidian["Obsidian UI Integration"]:::output

    %% Connections from Styling Assets to Build Process
    SCSS -->|"includes"| BuildProcess
    Flexcyon -->|"module input"| BuildProcess
    ThemeEntry -->|"entry point"| BuildProcess
    Modifiers -->|"plugin styles"| BuildProcess

    %% CI triggers Build Process
    CI_CD -->|"triggers"| BuildProcess

    %% Build Process generates Final Output
    BuildProcess -->|"generates"| FinalOutput

    %% Manifest influences the Final Output
    ManifestDist -->|"configures"| FinalOutput

    %% Final Output and Manifest are used by Obsidian
    FinalOutput -->|"loaded by"| Obsidian
    ManifestDist -->|"informs"| Obsidian

    %% Documentation informs Styling Assets
    DocDocs -->|"guides customization"| SCSS
    DocReadme -->|"provides instructions"| SCSS

    %% Click Events
    click SCSS "https://github.com/bladeacer/flexcyon/tree/master/scss/"
    click Flexcyon "https://github.com/bladeacer/flexcyon/tree/master/scss/flexcyon/"
    click ThemeEntry "https://github.com/bladeacer/flexcyon/blob/master/scss/theme.scss"
    click Modifiers "https://github.com/bladeacer/flexcyon/tree/master/scss/modifiers/"
    click ManifestDist "https://github.com/bladeacer/flexcyon/blob/master/manifest.json"
    click FinalOutput "https://github.com/bladeacer/flexcyon/blob/master/theme.css"
    click DocDocs "https://github.com/bladeacer/flexcyon/tree/master/docs/"
    click DocReadme "https://github.com/bladeacer/flexcyon/blob/master/README.md"
    click CI_CD "https://github.com/bladeacer/flexcyon/blob/master/.github/workflows/release.yml"

    %% Styles
    classDef source fill:#ffe6e6,stroke:#cc0000,stroke-width:2px;
    classDef process fill:#e6f2ff,stroke:#0066cc,stroke-width:2px;
    classDef output fill:#e6ffe6,stroke:#009933,stroke-width:2px;
```
