Projects

CodeWF.Markdown

avalonia markdown 渲染控制項與排版主題

项目说明

CodeWF.Markdown

CodeWF.Markdown

CodeWF.Markdown 是基于 Avalonia 12 的 Markdown 渲染控件、排版主题和可运行示例。该仓库从 CodeWF.AvaloniaControls 中拆分出来,专注维护 MarkdownViewer、主题资源和相关测试。

包線

說明
CodeWF.Markdown 完整 markdownviewer,支持常見 markdown 元素、代碼高亮、圖片預覽、svg/圖片、數學渲染擴展、多語言資源和增量渲染。
CodeWF.Markdown.Themes 默認控制項模板和多套排版主題。

安裝

Install-Package CodeWF.Markdown
Install-Package CodeWF.Markdown.Themes

使用方式

App.axaml 引入主题包:

<Application
    xmlns="https://github.com/avaloniaui"
    xmlns:markdown="https://codewf.com">
    <Application.Styles>
        <FluentTheme />
        <markdown:MarkdownThemes TypographyTheme="Simple" />
    </Application.Styles>
</Application>

在页面中使用 MarkdownViewer

<UserControl
    xmlns="https://github.com/avaloniaui"
    xmlns:md="https://codewf.com">
    <ScrollViewer
        HorizontalScrollBarVisibility="Disabled"
        VerticalScrollBarVisibility="Auto">
        <md:MarkdownViewer Markdown="{Binding Markdown}" />
    </ScrollViewer>
</UserControl>

倉庫結構

src/CodeWF.Markdown          MarkdownViewer 类库
src/CodeWF.Markdown.Themes   控件模板和排版主题
src/CodeWF.Markdown.Sample   示例工程
tests/CodeWF.Markdown.Tests  渲染和差异服务测试

適合關注

  • avalonia 應用需要直接渲染 markdown 內容。
  • 需要為文檔、更新日誌、ai 回復或幫助中心提供統一排版主題。
  • 需要支持圖片、svg、代碼高亮、多語言資源和增量渲染。
  • 希望用示例工程驗證不同 markdown 內容在桌面端的表現。

構建

dotnet restore CodeWF.Markdown.slnx
dotnet build CodeWF.Markdown.slnx --no-restore

倉庫