tegwick
e78ad47754
MAJOR FEATURES: - **Layered Theme Architecture**: Combine themes across UI, document, and branding scopes - **Advanced Theme Combinations**: Support complex themes like "dark,academic" or "light,github,corporate" - **Legacy Compatibility**: Existing --template usage continues to work seamlessly - **Enhanced CLI Validation**: Proper theme validation with helpful error messages TECHNICAL IMPROVEMENTS: - Replace DocumentManager with CleanDocumentManager throughout codebase - Add ThemeType custom click parameter with comprehensive validation - Implement parse_theme_string() and combine_theme_properties() functions - Add _get_template_css() and _generate_layered_css() methods - Support for UI themes (light/dark), document themes (basic/github/academic), and branding themes (corporate/startup) THEME CAPABILITIES: - **Single themes**: basic, github, dark, academic, light, corporate, startup - **Layered themes**: dark,academic combines dark UI with academic typography - **Complex combinations**: light,github,corporate for branded GitHub-style documents - **Intelligent property merging**: Later themes override earlier theme properties QUALITY ASSURANCE: - All template system tests passing (12/12) - Fixed import errors and missing dependencies - Updated test expectations for new validation messages - Comprehensive validation prevents unknown theme usage Breaking Change: --template parameter renamed to --theme with enhanced functionality 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
MarkiTect Documentation
Welcome to the MarkiTect documentation. This directory contains comprehensive documentation for developers, users, and contributors.
Documentation Structure
📐 Architecture Documentation (architecture/)
Deep technical documentation about system design, performance, and implementation details.
- Caching System - Why and how MarkiTect's AST caching delivers 60-85% performance improvements
- Coming soon: Database Schema, CLI Architecture, Plugin System
👥 User Guides (user-guides/)
End-user documentation for working with MarkiTect CLI and features.
- Coming soon: Getting Started, Command Reference, Best Practices
🔧 Development Documentation (development/)
Documentation for contributors and developers extending MarkiTect.
- Coming soon: Contributing Guide, Testing Strategy, Release Process
Quick Links
For Users
- Installation & Setup
- Command Reference (coming soon)
- Performance Guide (coming soon)
For Developers
- Architecture Overview - System design and component relationships
- Development Setup - Local development environment
- API Documentation (coming soon)
Project Management
- Project Status - Current development status
- Roadmap - Strategic development plan
- Current Tasks - Task management using Keep a Todofile format
Key Concepts
Core Architecture Principles
- Parse Once, Use Many Times - AST caching for 60-85% performance improvement
- Convention Over Configuration - Sensible defaults with minimal setup
- Schema-Driven Processing - Structured markdown with validation
- Relational Metadata - Database-powered document relationships
Performance Philosophy
MarkiTect treats markdown documents as structured, queryable data rather than plain text. This approach enables:
- Lightning-fast document processing through intelligent caching
- Complex querying and relationship management
- Schema validation and consistency enforcement
- Scalable performance that grows with your content
Contributing to Documentation
Documentation follows the same quality standards as code:
- Clear Structure - Logical organization and navigation
- Practical Examples - Real-world usage patterns
- Performance Context - Why architectural decisions matter
- User-Focused - Written for the intended audience
Documentation Standards
- Use clear, concise language
- Include practical examples
- Explain the "why" behind design decisions
- Keep technical accuracy as the highest priority
- Update docs when changing functionality
This documentation is maintained alongside the codebase. For the most current information, always refer to the latest version in the repository.