🧪 [Experiment] MarkdownTextBlock

[nerocui]

Approved from Discussion

#536

Problem Statement

Let's use this issue to track all improvements we are making to MardownTextBlock

Overview

This experiment adds the following components:

• MarkdownTextBlock a markdown control that uses the popular markdig parser for syntax parsing

Using

You can try it out via the NuGet Packages here:

• UWP: https://dev.azure.com/dotnet/CommunityToolkit/_artifacts/feed/CommunityToolkit-Labs/NuGet/CommunityToolkit.Labs.Uwp.Controls.MarkdownTextBlock/overview/0.1.241113-build.1784
• WinUI 3: https://dev.azure.com/dotnet/CommunityToolkit/_artifacts/feed/CommunityToolkit-Labs/NuGet/CommunityToolkit.Labs.WinUI.Controls.MarkdownTextBlock/overview/0.1.241113-build.1784
  Read more about Preview Packages here.

Additional info

No response

Implementation Requirements

• Working Prototype
• Feature Complete
• Documentation
• Samples
• Unit Tests
• Community Feedback / Usage Testimonies

Tested Platforms

• UWP
• WinAppSDK / WinUI 3
• Web Assembly (WASM)
• Android
• iOS
• MacOS
• Linux / GTK

Technical Review

• Accessibility Audit
• API/Naming Review
• Code Quality/Style
• Dependency Review
• Design/Style Review
• Final Approval

Community Help?

Yes

[rstewa]

If you don't set the MarkdownConfig should it be set to MarkdownConfig.Default by default? Right now, if you don't set MarkdownConfig it doesn't render. If that's the expected behavior, then you can ignore this.

[nerocui]

If you don't set the MarkdownConfig should it be set to MarkdownConfig.Default by default? Right now, if you don't set MarkdownConfig it doesn't render. If that's the expected behavior, then you can ignore this.

Yeah we'll address that in #611. Essentially no property should be "required" to just render some text.