How eli64s/splitme works
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.