Avalonia.MarkdownViewer

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

Avalonia.MarkdownViewer

★ 19 Open GitHub ↗

No description available.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Avalonia Markdown Viewer

[![NuGet](https://img.shields.io/nuget/v/MarkdownViewer.Core.svg)](https://www.nuget.org/packages/MarkdownViewer.Core/)

A modern, cross-platform Markdown viewer built with Avalonia UI framework, providing smooth rendering and interaction experience for Markdown documents.

![images/demo-light.png](https://raw.githubusercontent.com/LITTOMA/Avalonia.MarkdownViewer/refs/heads/master/images/demo-light.png)
![images/demo-dark.png](https://raw.githubusercontent.com/LITTOMA/Avalonia.MarkdownViewer/refs/heads/master/images/demo-dark.png)

## ✨ 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

- [X] Basic Markdown rendering
- [X] Image handling and caching
- [X] Link handling
- [X] 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

1. Clone the repository:

```bash
git clone [repository-url]
```

2. Navigate to the project directory:

```bash
cd Avalonia.Markdown
```

3. Build the project:

```bash
dotnet build
```

4. Run the application:

```bash
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](https://github.com/xoofx/markdig) - A fast, powerful, CommonMark compliant, extensible Markdown processor for .NET (BSD-2-Clause License)
- [Avalonia](https://github.com/AvaloniaUI/Avalonia) - A cross-platform .NET UI framework (MIT License)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

For third-party license notices, please see [THIRD-PARTY-NOTICES.txt](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

Avalonia.MarkdownViewer

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README