Skip to content

CHANGELOG.md

Latest commit

 

History

History
64 lines (55 loc) · 2.82 KB

CHANGELOG.md

File metadata and controls

64 lines (55 loc) · 2.82 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.2.0 - 2025-10-17

Changed

  • BREAKING: Renamed parent heading files from README.md to 00-__intro__.md
    • The 00- prefix ensures intro files sort first in directory listings
    • The __intro__ naming (double underscore) clearly marks these as special/meta files
    • Intro files are now always created for every heading folder, even when empty
    • This provides consistent structure and an easy place to add intro text later
    • Each intro file contains the heading declaration and any content before child sections
  • BREAKING: Changed frontmatter handling from 00-Frontmatter/README.md folder to 00-__frontmatter__.md file at root
    • Frontmatter is not a heading, so it doesn't need a folder structure
    • Only created when content exists before the first heading

Fixed

  • Fixed parser bug where headings were incorrectly nested under frontmatter node
  • Documents starting with H2 (without H1) now correctly parse and split

Added

  • Comprehensive test suite for new file structure (7 new tests)
  • Tests for frontmatter handling and round-trip conversion
  • Tests for empty intro files and file sorting order
  • Updated CLI help text with new file structure examples
  • Updated documentation with design decisions and rationale

0.1.0 - 2025-10-15

Added

  • Initial release of md-hierarchy CLI tool
  • Split markdown files into hierarchical folder structures based on heading levels
  • Merge folder structures back into single markdown files
  • Support for heading levels 1-4 with configurable extraction level
  • File naming with numeric prefixes and sanitized titles
  • README.md files for parent heading content
  • Edge case handling:
    • Empty headings → Untitled-Section-N
    • Duplicate headings → Append -2, -3, etc.
    • Skipped heading levels → Insert 00-Content/ folder
    • Content before first heading → 00-Frontmatter/README.md
    • Heading attributes preservation
  • Command-line options:
    • --level / -l: Specify heading level to extract (1-4)
    • --overwrite: Overwrite existing output directory
    • --verbose / -v: Print detailed operation log
    • --dry-run: Preview operations without writing files
  • Round-trip compatibility (split → merge produces equivalent content)
  • Preservation of all markdown elements:
    • Code blocks (fenced and indented)
    • Lists (ordered and unordered)
    • Tables
    • Images and links
    • Blockquotes
    • Horizontal rules
  • Comprehensive test suite
  • Documentation and usage examples