How eli64s/splitme-ai works
Main Components
a. Core Processing Engine:
• Core.py module which handles the main processing logic
• To the generators and utils packages
b. Input/Output Layer:
• At the top/bottom
• File input handling (Markdown files)
• Output generation (split Markdown files and MkDocs config)
c. Utility Services:
• On the left side
• File handling, filename sanitization, and reference link management
• Connection to the core processing engine
d. CLI Interface:
• On the right side
• Connection to the core engine and settings management
Component Relationships
[CLI Interface] → [Settings Manager]
• ↓
[Input Markdown] → [Core Processing Engine] → [Output Files]
• ↑ ↓
[Utility Services] ← [Generators]
Detailed Component Breakdown
Core Processing Engine:
• Core Engine (core.py)|
• Section Splitting |
• Hierarchy Handling |
• Content Processing |
Utility Services:
• Utils Package |
• FileHandler |
• FilenameSanitizer |
• ReferenceLinks |
Generators:
• Generators Package |
• MkDocs Config |
• Output Management |
Key Flows to Highlight
a. Input Processing Flow:
• Markdown file input → File Handler → Core Engine → Section Splitting
b. Output Generation Flow:
• Core Engine → Generators → File Handler → Output Files
c. Configuration Flow:
• CLI → Settings → Core Engine → Generators
Additional Elements
• Version information
• Supported Python versions
• External dependencies
• Error handling flow
Implementation Notes
• Maintain consistent spacing and alignment
• Brief descriptions for each major component
• Configuration file interactions
Remember to include the project's key features like heading-level-based splitting, filename sanitization, and MkDocs integration as annotations or notes in the relevant components.