README.md

Markdown Enumerator

A tool for managing and organizing numbered requirements in markdown files, teaching text processing, tree structures, and document analysis.

Level 0 - Basic Processing

• Implement markdown file reading
• Parse checkbox list items
• Detect reference patterns (e.g., R001)
• Extract number groups
• Create basic reporting
• Add simple validation

Level 1 - Tree Analysis

• Implement indentation level detection
• Add parent-child relationship tracking
• Create tree structure representation
• Support multiple number groups
• Add JSON export
• Implement reference inheritance

Level 2 - Validation & Linting

• Check for duplicate references
• Detect missing numbers
• Validate reference formats
• Check consistency of texts
• Create detailed error reports
• Add warning levels

Level 3 - Auto-fixing

• Generate missing references
• Auto-assign numbers to new items
• Implement smart inheritance rules
• Add batch processing
• Create backup system
• Support custom numbering schemes

Level 4 - Advanced Features

• Create interactive mode
• Add visual tree representation
• Implement change tracking
• Add version control integration
• Create documentation generator
• Support multiple file analysis

Reference Format

• Prefix: Uppercase characters (e.g., 'R', 'REQ')
• Number: 3 digits (e.g., '001', '042')
• Full reference: PREFIX + NUMBER (e.g., 'R001', 'REQ042')
• Usage: - [ ] (R001) Requirement text