MarkdownViewer.Core
1.0.5
dotnet add package MarkdownViewer.Core --version 1.0.5
NuGet\Install-Package MarkdownViewer.Core -Version 1.0.5
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MarkdownViewer.Core" Version="1.0.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MarkdownViewer.Core" Version="1.0.5" />
<PackageReference Include="MarkdownViewer.Core" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MarkdownViewer.Core --version 1.0.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MarkdownViewer.Core, 1.0.5"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package MarkdownViewer.Core@1.0.5
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MarkdownViewer.Core&version=1.0.5
#tool nuget:?package=MarkdownViewer.Core&version=1.0.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Avalonia Markdown Viewer
A modern, cross-platform Markdown viewer built with Avalonia UI framework, providing smooth rendering and interaction experience for Markdown documents.
✨ Features
- 🎯 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
🚥 Development Status
Current Version: Pre-release Status: Active Development
Roadmap
- Basic Markdown rendering
- Image handling and caching
- Link handling
- Dark/Light theme support
- Code syntax highlighting
- Custom styling options
📝 Markdown Support
Currently supports the following Markdown features:
Basic Syntax
- ✅ Headers (H1-H6)
- ✅ Emphasis (bold, italic)
- ✅ Lists (ordered and unordered)
- ✅ Links
- ✅ Images
- ✅ Blockquotes
- ✅ Code blocks
- ✅ Horizontal rules
Extended Syntax
- ✅ Tables
- ✅ Task lists
- ✅ Strikethrough
- ✅ Fenced code blocks
- ⚠️ Math equations (partial support)
- ⚠️ Footnotes (partial support)
- 🚧 Diagrams (planned)
- 🚧 Custom containers (planned)
🛠️ Technology Stack
- .NET 9.0
- Avalonia UI 11
- Markdig 0.40.0
- Microsoft.Extensions.Logging
📦 Project Structure
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
🚀 Getting Started
System Requirements
- .NET 9.0 SDK or higher
- Supported OS: Windows, Linux, macOS
Build Steps
- 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
🔧 Core Features
- Real-time Markdown rendering
- Automatic image preloading and caching
- Link click handling
- Memory-optimized image compression
- Modern user interface
🤝 Contributing
Contributions are welcome! Feel free to submit issues and pull requests.
📢 Known Issues
- 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
Dependencies
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)
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.
📝 Changelog
v1.0.3
New Features
- 🔄 Added automatic theme change detection and content re-rendering
v1.0.2
New Features
- ✨ Added support for .NET 8 LTS
- 🔄 Now supports both .NET 8 and .NET 9
Improvements
- 🔧 Improved Markdown rendering and parsing functionality
- 📝 Enhanced code block rendering
- 🔗 Improved link handling mechanism
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- Avalonia (>= 11.2.3)
- Markdig (>= 0.40.0)
- Microsoft.Extensions.Logging (>= 9.0.2)
-
net9.0
- Avalonia (>= 11.2.3)
- Markdig (>= 0.40.0)
- Microsoft.Extensions.Logging (>= 9.0.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on MarkdownViewer.Core:
| Repository | Stars |
|---|---|
|
sn4k3/NetSonar
Network pings and other utilities
|
- Fix inline code rendering issue within lists.