{"id":23387191,"url":"https://github.com/felix-codingclimber/dotnetelements.wpf.markdown","last_synced_at":"2025-04-11T05:09:30.210Z","repository":{"id":268587836,"uuid":"904848002","full_name":"Felix-CodingClimber/DotNetElements.Wpf.Markdown","owner":"Felix-CodingClimber","description":"This project provides a simple markdown renderer for WPF.","archived":false,"fork":false,"pushed_at":"2024-12-23T06:54:50.000Z","size":148,"stargazers_count":2,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T05:09:19.458Z","etag":null,"topics":["csharp","dotnet","markdig","markdown","wpf"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Felix-CodingClimber.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-17T17:02:08.000Z","updated_at":"2024-12-22T16:25:13.000Z","dependencies_parsed_at":"2024-12-17T18:19:34.405Z","dependency_job_id":"c7939ed2-6ed8-412a-abea-1153eb2c1c4e","html_url":"https://github.com/Felix-CodingClimber/DotNetElements.Wpf.Markdown","commit_stats":null,"previous_names":["felix-codingclimber/dotnetelements.wpf.markdown"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Felix-CodingClimber%2FDotNetElements.Wpf.Markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Felix-CodingClimber%2FDotNetElements.Wpf.Markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Felix-CodingClimber%2FDotNetElements.Wpf.Markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Felix-CodingClimber%2FDotNetElements.Wpf.Markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Felix-CodingClimber","download_url":"https://codeload.github.com/Felix-CodingClimber/DotNetElements.Wpf.Markdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248345266,"owners_count":21088244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","dotnet","markdig","markdown","wpf"],"created_at":"2024-12-22T01:15:09.943Z","updated_at":"2025-04-11T05:09:30.202Z","avatar_url":"https://github.com/Felix-CodingClimber.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"## About\n\nThis project provides a markdown renderer for WPF.\nMarkdown is rendered to a FlowDocument.\nThis implementation uses the popular [Markdig](https://github.com/xoofx/markdig) library for parsing.\n\nAt the current state, all common markdown features are supported (There might be some missing edge cases).\nSome of the most used Markdig extensions are also supported.\n\n#### Supported features:\n- CommonMark\n\u003e [!IMPORTANT]\n\u003e 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)\n- Pipe tables\n- Alert blocks (github)\n- Task lists\n- Code block syntax highlighting\n- Emphasis extras\n- Defined image size (`![Image](img/exampleImg.png=100x100)`)\n- Auto links\n\n#### Missing features we would like to implement:\n- Footnotes\n- Emoji extension (add support for colored font emoji)\n- Option to implement other Markdig extensions and provide custom renderers\n- Improved theme for light mode\n- Default theme for dark mode\n\n## Recommended setup\n\n1. Install nuget package `\u003e dotnet add package DotNetElements.Wpf.Markdown --version \u003cinsert-latest-version-here\u003e`\n\n2. Add styles to `App.xaml`\n```xaml\n\u003cApplication.Resources\u003e\n    \u003cResourceDictionary\u003e\n        \u003cResourceDictionary.MergedDictionaries\u003e\n            \u003cResourceDictionary Source=\"pack://application:,,,/DotNetElements.Wpf.Markdown;Component/Themes/Generic.xaml\" /\u003e\n        \u003c/ResourceDictionary.MergedDictionaries\u003e\n    \u003c/ResourceDictionary\u003e\n\u003c/Application.Resources\u003e\n```\n\n2. Add xaml namespace\n```xaml\nxmlns:markdown=\"clr-namespace:DotNetElements.Wpf.Markdown;assembly=DotNetElements.Wpf.Markdown\"\n```\n\n3. Add `MarkdownTextBlock`\n```xaml\n\u003cmarkdown:MarkdownTextBlock x:Name=\"MarkdownTextBlock\" FontFamily=\"Segoe UI\" /\u003e\n```\n\n4. Set the `Text` property (binding is supported)\n```cs\nMarkdownTextBlock.Text = \"Hello world from **DotNetElements.Wpf.Markdown**\";\n```\n\n5. To change the styling options for the different markdown blocks, add a customized `MarkdownThemes.cs`\n```cs\nMarkdownThemes myTheme = MarkdownThemes.Default;\nmyTheme.InlineCodeBackground = new SolidColorBrush(Colors.HotPink);\n\nMarkdownTextBlock.Theme = myTheme;\n```\n\n## Third party notices\n\nThe project is a port of the CommunityToolkit MarkdownTextBlock component to the WPF framework.\n\nSee [CommunityToolkit/Labs-Windows/MarkdownTextBlock](https://github.com/CommunityToolkit/Labs-Windows/tree/a37acd33031037daa4d39318e3a10741b1c046ea/components/MarkdownTextBlock)\n\nThe 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)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffelix-codingclimber%2Fdotnetelements.wpf.markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffelix-codingclimber%2Fdotnetelements.wpf.markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffelix-codingclimber%2Fdotnetelements.wpf.markdown/lists"}