@asafarim/simple-md-viewer/dist/md-docs/docs/examples/changelog.md

A professional markdown viewer with file tree navigation, directory content browsing, and advanced YAML front matter support

# Changelog

All notable changes to the Markdown Explorer Viewer will be documented in this file.

## [1.0.0] - 2024-01-15

### 🎉 Initial Release

This is the first stable release of the Markdown Explorer Viewer!

### ✨ Features Added

- **File Tree Navigation** - Interactive folder and file browser
- **Markdown Rendering** - Full GitHub Flavored Markdown support
- **Search Functionality** - Real-time search through files and content
- **Theme Support** - Light, dark, and auto themes
- **Responsive Design** - Mobile-friendly with collapsible sidebar
- **Breadcrumb Navigation** - Easy navigation with clickable breadcrumbs
- **TypeScript Support** - Complete type definitions included
- **Accessibility** - Full keyboard navigation and screen reader support

### 📚 Components

- `MarkdownExplorer` - Main component with integrated file tree and viewer
- `FileTree` - Standalone file tree component
- `MarkdownViewer` - Pure markdown rendering component
- `Breadcrumbs` - Navigation breadcrumb component

### 🛠️ Utility Functions

- `parseFileTree()` - Convert flat file structure to hierarchical tree
- `findNodeByPath()` - Find specific nodes in the file tree
- `searchNodes()` - Search for nodes matching a query
- `generateBreadcrumbs()` - Create breadcrumb navigation items
- Theme utilities for light/dark mode handling

### 🎨 Styling

- CSS modules for component styling
- CSS custom properties for easy theming
- Responsive design with mobile-first approach
- Support for custom icons and styling

### 📦 Dependencies

- React 18+ support
- React Router integration ready
- Minimal external dependencies
- Tree-shakeable for optimal bundle size

---

## Future Releases

### Planned for v1.1.0

- **Enhanced Search** - Full-text search with highlighting
- **File Metadata** - Display file sizes, modification dates
- **Export Functionality** - Export selected files or entire trees
- **Performance Improvements** - Virtual scrolling for large file trees
- **Plugin System** - Custom markdown processors and renderers

### Planned for v1.2.0

- **Real-time Collaboration** - Multi-user editing and navigation
- **Version Control Integration** - Git integration for file history
- **Advanced Theming** - Theme builder and more built-in themes
- **Internationalization** - Multi-language support for UI

### Planned for v2.0.0

- **Visual Editor** - WYSIWYG markdown editing
- **Media Support** - Enhanced image, video, and file handling
- **API Integration** - Direct CMS and headless CMS integration
- **Advanced Analytics** - Usage tracking and insights

---

## Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to:

- Report bugs
- Suggest new features
- Submit pull requests
- Help with documentation

## Support

If you encounter any issues or have questions:

- 📝 [Create an issue](https://github.com/AliSafari-IT/asafarim-webapp/issues)
- 💬 [Join our discussions](https://github.com/AliSafari-IT/asafarim-webapp/discussions)
- 📧 [Contact support](mailto:support@asafarim.com)

Thank you for using Markdown Explorer Viewer! 🚀