# eli64s/splitme architecture

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

- Interactive diagram: https://gitdiagram.com/eli64s/splitme
- Repository: https://github.com/eli64s/splitme

## Overview

##### Main Components Identification

The system should be divided into these core components:

a) Core Processing Engine
- Located in src/splitme/core.py
- Handles the main processing logic and orchestration

b) CLI Interface
- Located in src/splitme/cli.py
- Manages user interactions and command processing

c) Tools Module
- Located in src/splitme/tools/
- Contains specialized tools for HTML and Markdown processing
- Features link validation, reference link conversion, and extraction

d) Generators Module
- Located in src/splitme/generators/
- Supports multiple documentation platforms (MkDocs, Mintlify)
- Handles configuration generation

e) Utilities Module
- Located in src/splitme/utils/
- Provides supporting functionality like file handling and filename sanitization

##### Component Relationships

**User Input → CLI Interface → Core Processing Engine**
- ↓
- ┌──────┴──────┐
- ↓             ↓
- Tools Module  Generators Module
- ↑             ↑
- ┬──────┘
- ↓
- Utilities Module

##### Specific Design Elements

- Blue: User-facing components (CLI)
- Green: Core processing components
- Yellow: Tool components
- Purple: Generator components
- Gray: Utility components

b) Component Representations:
- Use rectangles for modules
- Use hexagons for entry points

##### Detailed Component Breakdown

Tools Module:
**Tools Module**
- Markdown Tools
- Link Validator
- Reference Link Converter
- Reference Link Extractor
- HTML Tools

Generators Module:
**Generators Module**
- MkDocs Generator
- Config Generator
- Mintlify Generator

##### Key Workflows to Highlight

a) Text Splitting Workflow:
**Input Markdown → Core Engine → File Handler → Output Files**

b) Link Processing Workflow:
**Input Markdown → Link Validator → Validation Results**

c) Documentation Generation Workflow:
**Input Markdown → Core Engine → Generator → Config Files**

##### External Dependencies

Interactions with:
- File System (for input/output operations)
- External Documentation Platforms (MkDocs, Mintlify)
- URL Validation Services

This system design should effectively communicate how Splitme processes Markdown content, manages documentation, and integrates with various documentation platforms while maintaining a modular and extensible architecture.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles and classes
    classDef cli fill:#3498db,stroke:#2980b9,color:white
    classDef core fill:#2ecc71,stroke:#27ae60,color:white
    classDef tools fill:#f1c40f,stroke:#f39c12,color:black
    classDef generators fill:#9b59b6,stroke:#8e44ad,color:white
    classDef utils fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef system fill:#e74c3c,stroke:#c0392b,color:white

    %% User Input and CLI
    User([User Input])
    CLI["CLI Interface"]:::cli
    click CLI "https://github.com/eli64s/splitme/blob/main/src/splitme/cli.py"

    %% Core Components
    Core["Core Processing Engine"]:::core
    click Core "https://github.com/eli64s/splitme/blob/main/src/splitme/core.py"

    %% System Components
    Config["Configuration Management"]:::system
    click Config "https://github.com/eli64s/splitme/blob/main/src/splitme/config.py"
    Logger["Logging System"]:::system
    click Logger "https://github.com/eli64s/splitme/blob/main/src/splitme/logger.py"
    Errors["Error Handling"]:::system
    click Errors "https://github.com/eli64s/splitme/blob/main/src/splitme/errors.py"
    Validators["Validation System"]:::system
    click Validators "https://github.com/eli64s/splitme/blob/main/src/splitme/validators.py"

    %% Tools Module
    subgraph Tools["Tools Module"]
        direction TB
        MDTools["Markdown Tools"]:::tools
        HTMLTools["HTML Tools"]:::tools
        
        subgraph MarkdownTools["Markdown Processing"]
            direction TB
            LinkVal["Link Validator"]:::tools
            RefConv["Reference Link Converter"]:::tools
            RefExt["Reference Link Extractor"]:::tools
        end
    end
    click Tools "https://github.com/eli64s/splitme/tree/main/src/splitme/tools/"
    click HTMLTools "https://github.com/eli64s/splitme/tree/main/src/splitme/tools/html/"
    click LinkVal "https://github.com/eli64s/splitme/blob/main/src/splitme/tools/markdown/link_validator.py"
    click RefConv "https://github.com/eli64s/splitme/blob/main/src/splitme/tools/markdown/reflink_converter.py"
    click RefExt "https://github.com/eli64s/splitme/blob/main/src/splitme/tools/markdown/reflink_extractor.py"

    %% Generators Module
    subgraph Generators["Generators Module"]
        direction TB
        MkDocs["MkDocs Generator"]:::generators
        Mintlify["Mintlify Generator"]:::generators
        ConfigGen["Config Generator"]:::generators
    end
    click Generators "https://github.com/eli64s/splitme/tree/main/src/splitme/generators/"
    click MkDocs "https://github.com/eli64s/splitme/tree/main/src/splitme/generators/mkdocs/"
    click Mintlify "https://github.com/eli64s/splitme/tree/main/src/splitme/generators/mintlify/"
    click ConfigGen "https://github.com/eli64s/splitme/blob/main/src/splitme/generators/mkdocs/config.py"

    %% Utils Module
    subgraph Utils["Utilities Module"]
        direction TB
        FileHandler["File Handler"]:::utils
        FileSanitizer["Filename Sanitizer"]:::utils
    end
    click Utils "https://github.com/eli64s/splitme/tree/main/src/splitme/utils/"
    click FileHandler "https://github.com/eli64s/splitme/blob/main/src/splitme/utils/file_handler.py"
    click FileSanitizer "https://github.com/eli64s/splitme/blob/main/src/splitme/utils/filename_sanitizer.py"

    %% External Systems
    FileSystem[("File System")]
    DocPlatforms["Documentation Platforms"]
    URLServices["URL Validation Services"]

    %% Relationships
    User --> CLI
    CLI --> Core
    Core --> Tools
    Core --> Generators
    Core --> Utils
    
    Tools --> Utils
    Generators --> Utils
    
    Core --> Config
    Core --> Logger
    Core --> Errors
    Core --> Validators
    
    Utils --> FileSystem
    Generators --> DocPlatforms
    Tools --> URLServices

    %% Legend
    subgraph Legend
        direction TB
        CLI_L["CLI Components"]:::cli
        Core_L["Core Components"]:::core
        Tools_L["Tool Components"]:::tools
        Gen_L["Generator Components"]:::generators
        Utils_L["Utility Components"]:::utils
        Sys_L["System Components"]:::system
    end
```
