|
1 | 1 | ## About |
2 | 2 |
|
3 | | -This project provides a simple markdown renderer for WPF. |
| 3 | +This project provides a markdown renderer for WPF. |
| 4 | +Markdown is rendered to a FlowDocument. |
4 | 5 | This implementation uses the popular [Markdig](https://github.com/xoofx/markdig) library for parsing. |
| 6 | + |
5 | 7 | At the current state, all common markdown features are supported (There might be some missing edge cases). |
6 | | -Styling options and default style for the markdown blocks need to be improved. |
| 8 | +Some of the most used Markdig extensions are also supported. |
| 9 | + |
| 10 | +#### Supported features: |
| 11 | +- CommonMark |
| 12 | + > [!IMPORTANT] |
| 13 | + > Currently there are no plans to support (Raw HTML)[https://spec.commonmark.org/0.31.2/#raw-html] and (HTML blocks)[https://spec.commonmark.org/0.31.2/#html-blocks] |
| 14 | +- Pipe tables |
| 15 | +- Alert blocks (github) |
| 16 | +- Task lists |
| 17 | +- Code block syntax highlighting |
| 18 | +- Emphasis extras |
| 19 | +- Defined image size (``) |
| 20 | +- Auto links |
7 | 21 |
|
8 | | -#### Missing features to implement: |
9 | | -- [ ] Code block syntax highlighting |
10 | | -- [ ] Option to implement other Markdig extensions |
11 | | -- [ ] Default theme for dark mode |
| 22 | +#### Missing features we would like to implement: |
| 23 | +- Footnotes |
| 24 | +- Emoji extension |
| 25 | +- Option to implement other Markdig extensions and provide custom renderers |
| 26 | +- Improved theme for light mode |
| 27 | +- Default theme for dark mode |
12 | 28 |
|
13 | 29 | ## Recommended setup |
14 | 30 |
|
@@ -52,4 +68,6 @@ MarkdownTextBlock.Theme = myTheme; |
52 | 68 |
|
53 | 69 | The project is a port of the CommunityToolkit MarkdownTextBlock component to the WPF framework. |
54 | 70 |
|
55 | | -See [CommunityToolkit/Labs-Windows/MarkdownTextBlock](https://github.com/CommunityToolkit/Labs-Windows/tree/a37acd33031037daa4d39318e3a10741b1c046ea/components/MarkdownTextBlock) |
| 71 | +See [CommunityToolkit/Labs-Windows/MarkdownTextBlock](https://github.com/CommunityToolkit/Labs-Windows/tree/a37acd33031037daa4d39318e3a10741b1c046ea/components/MarkdownTextBlock) |
| 72 | + |
| 73 | +The code block syntax highlighting uses [ColorCode-Universal](https://github.com/CommunityToolkit/ColorCode-Universal) and a customized version of [ColorCode-WPF](https://github.com/coltrane2ny/ColorCode-WPF) |
0 commit comments