Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/felix-codingclimber/dotnetelements.wpf.markdown
This project provides a simple markdown renderer for WPF.
https://github.com/felix-codingclimber/dotnetelements.wpf.markdown
csharp dotnet markdig markdown wpf
Last synced: 27 days ago
JSON representation
This project provides a simple markdown renderer for WPF.
- Host: GitHub
- URL: https://github.com/felix-codingclimber/dotnetelements.wpf.markdown
- Owner: Felix-CodingClimber
- License: mit
- Created: 2024-12-17T17:02:08.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-17T17:12:32.000Z (about 1 month ago)
- Last Synced: 2024-12-17T18:19:30.826Z (about 1 month ago)
- Topics: csharp, dotnet, markdig, markdown, wpf
- Language: C#
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About
This project provides a simple markdown renderer for WPF.
This implementation uses the popular [Markdig](https://github.com/xoofx/markdig) library for parsing.
At the current state, all common markdown features are supported (There might be some missing edge cases).
Styling options and default style for the markdown blocks need to be improved.
#### Missing features to implement:
- [ ] Code block syntax highlighting
- [ ] Option to implement other Markdig extensions
- [ ] Default theme for dark mode
## Recommended setup
1. Install nuget package `> dotnet add package DotNetElements.Wpf.Markdown --version `
2. Add styles to `App.xaml`
```xaml
```
2. Add xaml namespace
```xaml
xmlns:markdown="clr-namespace:DotNetElements.Wpf.Markdown;assembly=DotNetElements.Wpf.Markdown"
```
3. Add `MarkdownTextBlock`
```xaml
```
4. Set the `Text` property (binding is supported)
```cs
MarkdownTextBlock.Text = "Hello world from **DotNetElements.Wpf.Markdown**";
```
5. To change the styling options for the different markdown blocks, add a customized `MarkdownThemes.cs`
```cs
MarkdownThemes myTheme = MarkdownThemes.Default;
myTheme.InlineCodeBackground = new SolidColorBrush(Colors.HotPink);
MarkdownTextBlock.Theme = myTheme;
```
## Third party notices
The project is a port of the CommunityToolkit MarkdownTextBlock component to the WPF framework.
See [CommunityToolkit/Labs-Windows/MarkdownTextBlock](https://github.com/CommunityToolkit/Labs-Windows/tree/a37acd33031037daa4d39318e3a10741b1c046ea/components/MarkdownTextBlock)