A modern, cross-platform Markdown viewer built with Avalonia UI framework, providing smooth rendering and interaction experience for Markdown documents.
- 🎯 Built with Avalonia UI 11 for cross-platform support
- 📝 High-quality Markdown rendering powered by Markdig engine
- 🖼️ Image preloading and caching mechanism
- 🔗 Built-in link handler
- 🚀 High-performance rendering implementation
- ⚡ Memory-optimized image compression
Current Version: Pre-release Status: Active Development
- Basic Markdown rendering
- Image handling and caching
- Link handling
- Dark/Light theme support
- Code syntax highlighting
- Custom styling options
Currently supports the following Markdown features:
- ✅ Headers (H1-H6)
- ✅ Emphasis (bold, italic)
- ✅ Lists (ordered and unordered)
- ✅ Links
- ✅ Images
- ✅ Blockquotes
- ✅ Code blocks
- ✅ Horizontal rules
- ✅ Tables
- ✅ Task lists
- ✅ Strikethrough
- ✅ Fenced code blocks
⚠️ Math equations (partial support)⚠️ Footnotes (partial support)- 🚧 Diagrams (planned)
- 🚧 Custom containers (planned)
- .NET 9.0
- Avalonia UI 11
- Markdig 0.40.0
- Microsoft.Extensions.Logging
The project consists of two main parts:
- MarkdownViewer.Core: Core library containing Markdown parsing, rendering, and various service implementations
- MarkdownViewer.Avalonia: Avalonia UI application providing the user interface and interaction features
- .NET 9.0 SDK or higher
- Supported OS: Windows, Linux, macOS
- Clone the repository:
git clone [repository-url]- Navigate to the project directory:
cd Avalonia.Markdown- Build the project:
dotnet build- Run the application:
dotnet run --project MarkdownViewer.Avalonia- Real-time Markdown rendering
- Automatic image preloading and caching
- Link click handling
- Memory-optimized image compression
- Modern user interface
Contributions are welcome! Feel free to submit issues and pull requests.
- Large images may take longer to load on first render
- Some complex math equations might not render correctly
- Custom emoji shortcodes are not currently supported
This project uses the following open source components:
- Markdig - A fast, powerful, CommonMark compliant, extensible Markdown processor for .NET (BSD-2-Clause License)
- Avalonia - A cross-platform .NET UI framework (MIT License)
This project is licensed under the MIT License - see the LICENSE file for details.
For third-party license notices, please see THIRD-PARTY-NOTICES.txt.
- 🔄 Added automatic theme change detection and content re-rendering
- ✨ Added support for .NET 8 LTS
- 🔄 Now supports both .NET 8 and .NET 9
- 🔧 Improved Markdown rendering and parsing functionality
- 📝 Enhanced code block rendering
- 🔗 Improved link handling mechanism