Skip to content

v1.1.0#2

Merged
wflixu merged 6 commits intomainfrom
dev
Dec 13, 2025
Merged

v1.1.0#2
wflixu merged 6 commits intomainfrom
dev

Conversation

@wflixu
Copy link
Owner

@wflixu wflixu commented Dec 13, 2025

No description provided.

wflixu and others added 6 commits December 13, 2025 18:11
- Change pack function to use relative paths (./assets/...) instead of assets:// protocol
- Update link generation in update_markdown_links function
- Update mdz-spec.md to use relative path references
- Update CLAUDE.md project documentation
- Improves compatibility when .mdz files are renamed to .zip and manually extracted
- Users can now view images in extracted files with standard Markdown viewers

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Update Manifest structure to make filename field optional (Option<String>)
- Add smart fallback for old MDZ files: derive filename from input path
- Fix unpacking of legacy MDZ files created with v1.0.0
- Update all related tests to use optional filename field
- Version bump to 1.1.0 for both library and CLI
- Update VS Code extension to version 1.1.0 with compatibility fixes

Resolves issue: "Error: missing field `filename` at line 29 column 1"

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Major documentation updates to reflect comprehensive MDZ ecosystem:

README.md:
- Add project badges (Crates.io, VS Code Marketplace, License)
- Complete rewrite with modern structure and emojis
- Add VS Code extension installation and usage
- Include comprehensive feature overview with smart capabilities
- Add development setup and project statistics
- Enhance contribution guidelines and acknowledgments
- Update to v1.1.0 installation instructions

mdz-spec.md:
- Update specification version to v1.1.0
- Add version history with v1.1.0 compatibility improvements
- Update manifest.json schema with optional filename field
- Add VS Code extension implementation section
- Include installation and configuration details
- Update field descriptions with backward compatibility notes

Both documents now reflect complete ecosystem including:
- Rust core library and CLI tool
- VS Code extension integration
- Backward compatibility improvements
- Smart asset handling features
- Comprehensive installation guides

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add comprehensive documentation following Rust best practices:

README.md:
- Create dedicated README for mdz-rs library with crate-level documentation
- Add quick start guide, API reference, and usage examples
- Include detailed feature descriptions and use cases
- Add badges for crates.io, documentation, and license
- Provide comprehensive dependency and setup information

Library Documentation:
- Add crate-level documentation with module overview and features
- Document all public functions with detailed doc comments
- Include examples, error conditions, and parameter descriptions
- Add Asset and Manifest struct documentation with examples
- Provide backward compatibility information for unpack function
- Fix Rust doc code block formatting (text vs rust)

Cargo.toml:
- Update description to focus on library capabilities
- Fix documentation URL to point to docs.rs
- Improve package metadata for better crate discovery

Documentation now provides:
- Complete API documentation for all public functions
- Detailed examples for pack/unpack operations
- Clear error handling guidance
- Backward compatibility notes
- Professional crate presentation

This resolves the "no README.md file" issue on crates.io and provides
excellent developer experience for library users.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Major release positioning MDZ as "The New File Format for Self-Contained Markdown Documents"

Key Enhancements:
📚 README.md Complete Rewrite:
- Reposition MDZ as innovative file format, not compression tool
- Add strong problem/solution narrative for Markdown sharing
- Include comprehensive use cases (bloggers, writers, developers, educators)
- Add competitive analysis vs ZIP, Git repos, static sites, PDF
- Feature real-world scenarios and before/after comparisons
- Professional value proposition and target audience segmentation

📋 mdz-spec.md Technical Enhancement:
- Complete specification restructure focusing on file format innovation
- Add design philosophy explaining why MDZ is needed
- Include detailed use cases and workflow examples
- Add success stories from real implementations
- Provide best practices for content creation and distribution
- Outline future enhancement roadmap and extensibility plans

🎯 Core Messaging Changes:
- "The New File Format for Self-Contained Markdown Documents"
- Emphasize single-file, complete-story distribution model
- Highlight universal portability and offline capabilities
- Focus on solving fundamental Markdown sharing challenges

Technical Improvements:
- Enhanced versioning support with backward compatibility (v1.0.0 → v1.1.0)
- Comprehensive asset handling with smart processing
- Rich metadata support for document management
- Open standard based on ZIP with Markdown-specific optimizations

This release transforms MDZ from a technical tool into a comprehensive solution for
self-contained document distribution, positioning it as the standard format for modern
Markdown sharing workflows.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@wflixu wflixu merged commit b09c3b5 into main Dec 13, 2025
4 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant