Asp.net core中如何让blog的内容支持markdown

admin | 2026-04-09 09:35 | 阅读 11 次

在 ASP.NET Core 中让 Blog 内容支持 Markdown，核心思路是在后端进行解析渲染或在前端进行解析渲染。考虑到 SEO（搜索引擎优化）和首屏加载速度，通常推荐在后端（C#）将 Markdown 转换为 HTML。

以下是基于 ASP.NET Core 实现 Markdown 支持的完整方案：

1. 核心实现方案：后端解析（推荐）

这是最主流的做法。用户在后台编辑器（如 Markdown 编辑器）中输入 Markdown 源码并存储到数据库。在展示博客时，服务器读取源码，使用 C# 库将其转换为 HTML，然后发送给浏览器。

步骤一：选择 Markdown 解析库

你需要在项目中引入一个 C# 的 Markdown 解析库。最常用的是 Markdig，它速度快、安全且扩展性强。

在你的项目目录下运行以下命令安装 NuGet 包：

dotnet add package Markdig

步骤二：创建服务进行转换

创建一个服务类（例如 MarkdownService），专门负责将 Markdown 字符串转换为 HTML。

using Markdig;

public class MarkdownService
{
    public string ConvertToHtml(string markdown)
    {
        if (string.IsNullOrEmpty(markdown))
            return string.Empty;

        // 使用 Markdig 的默认管道（包含常用扩展，如表格、围栏代码块等）
        var pipeline = new MarkdownPipelineBuilder().UseAdvancedExtensions().Build();
        
        // 转换
        var html = Markdown.ToHtml(markdown, pipeline);
        
        return html;
    }
}

步骤三：在 Controller 中调用

在你的 Blog Controller 中，获取数据库中的 Markdown 内容，转换后再传给 View。

public class BlogController : Controller
{
    private readonly MarkdownService _markdownService;

    public BlogController(MarkdownService markdownService)
    {
        _markdownService = markdownService;
    }

    public IActionResult Post(int id)
    {
        // 1. 从数据库获取博客实体
        var post = _blogRepository.GetById(id); 
        
        // 2. 转换 Markdown 为 HTML
        post.ContentHtml = _markdownService.ConvertToHtml(post.ContentMarkdown);

        // 3. 传递给视图
        return View(post);
    }
}

步骤四：在 View (Razor) 中显示

在 Razor 视图中，使用 @Html.Raw() 方法输出 HTML，防止 ASP.NET Core 自动对 HTML 标签进行编码（转义）。

@model BlogPost

<article>
    <h1>@Model.Title</h1>
    <!-- 注意：必须使用 Raw 方法，否则会显示成 <p>文本</p> 而不是段落 -->
    @Html.Raw(Model.ContentHtml) 
</article>

2. 方案二：前端解析（备选）

如果你希望减轻服务器压力，或者使用了 SPA（单页应用）架构，可以在前端解析。

实现方式：

后端：直接将 Markdown 源码通过 API 发送给前端（不需要转换）。
前端：使用 JavaScript 库（如 marked.js 或 highlight.js）进行解析。

优点：服务器逻辑简单，渲染由客户端完成。缺点：不利于 SEO（搜索引擎可能抓取不到渲染后的内容），首屏加载可能有闪烁（先显示源码，后渲染）。

3. 安全性建议（重要）

Markdown 转换后的 HTML 可能包含恶意脚本（XSS 攻击）。虽然 ASP.NET Core 默认会对 @Model.Content 进行 HTML 编码，但因为我们使用了 @Html.Raw 绕过了编码，所以必须在转换前或转换后进行清理。

推荐使用 Markdig 的安全扩展：

var pipeline = new MarkdownPipelineBuilder()
    .UseAdvancedExtensions()
    // 移除 HTML 标签，或者使用 SanitizerExtension 来清理不安全的属性
    .UseHtmlSanitizer() 
    .Build();

或者在安装包时引入 Markdig.HtmlSanitizer。

总结

| 方案 | 技术栈 | 适用场景 | | :--- | :--- | :--- | | 后端解析 (推荐) | C# + Markdig | 普通的 ASP.NET Core MVC/Razor Pages 博客，注重 SEO 和首屏速度。 | | 前端解析 | JavaScript (marked.js) | 前后端分离架构，或静态站点生成器。 |

对于大多数 ASP.NET Core 开发者，建议采用 Markdig 库在后端进行解析。