Initial Release of Mirror Docs!

This release marks the first public version of mirror-docs, a CLI tool designed to streamline documentation access and integration.

Key Features:

• HTML to Markdown Conversion: Mirrors HTML documentation from any website and converts it into clean, readable Markdown format.
• Sitemap Generation: Automatically generates a sitemap.txt file, including page titles for improved navigation and AI integration.
• AI Integration Focus: Optimized for creating local, token-efficient documentation mirrors, enabling faster and more cost-effective integration with AI assistants.
• Easy Installation: Simple installation via pip using the generated pyproject.toml.
• Configurable: Command-line arguments allow you to specify the domain, documentation path, output directory, and sitemap file name.

Benefits:

• Consolidated Documentation: Combines documentation from multiple sources into a single, unified location.
• Improved Accessibility: Makes documentation easier to find and access.
• Token Savings: Reduces the need for costly online lookups by providing a local documentation knowledge base.
• Faster Call Speeds: Improves the speed of documentation access for AI assistants.

Improvements:

• Added HTML <title> extraction using BeautifulSoup.
• Modified sitemap generation to include page titles (path :: title format).
• Added a User-Agent string to the wget command.
• Improved wget execution logging and error handling.

This initial release provides a solid foundation for mirroring and converting HTML documentation to Markdown. We encourage you to try it out and provide feedback!