markdig

markdig

markdig是.NET的快速，功能强大，符合标记的，可扩展的Markdown处理器。

注意：存储库正在建设中。在某个时候将有一个专用的网站和适当的文档！

您可以在线尝试markdig并将其与Babelmark上的其他实现进行比较。3

特征

• 非常快速的解析器和HTML渲染器（NO-REGEXP），就GC压力而言非常轻。请参阅基准
• 摘要语法树具有语法树的精确源代码位置，在构建Markdown编辑器时很有用。
  • Checkout Markdown编辑器V2，用于Visual Studio 2022由markdig提供支持！
• 转换为HTML
• 从最新的CommonMark规格（0.31.2）中通过600多个测试
• 包括Commonmark的所有核心要素：
  • 包括GFM围栏代码块。
• 可扩展的架构
  • 即使是核心的降价/CONCORMARK解析也可以插入，因此它允许禁用内置的Markdown/Commonmark解析（例如禁用HTML解析）或更改行为（例如，标头的更改匹配#与@ ）
• 往返支持：解析琐事（Whitespace，Newlines和其他角色），以支持无损解析⭢渲染往返。这可以更改降级文档，而无需引入不希望的琐事更改。
• 内置具有20多个扩展名，包括：
  • 2种表：
    • 管桌（灵感来自github桌子和潘多克 – 管道表）
    • 网格表（灵感来自Pandoc-网格表）
  • 额外的重点（灵感来自Pandoc-强调和Markdown -IT）
    • 罢工~~ ，
    • 下标~
    • 上标^
    • 插入++
    • 标记==
  • 特殊属性或随附的HTML属性（灵感来自PHP Markdown额外 – 特殊属性）
  • 定义列表（灵感来自PHP Markdown额外的定义列表）
  • 脚注（灵感来自php markdown额外的脚注）
  • 标题的自动标识符（类似于Pandoc -Auto Identifies）
  • 如果文本以http://或https https://或ftp://或mailto:或www.xxx.yyy
  • 从GITHUB任务列表启发的任务列表。
  • 额外的子弹列表，支持Alpha子弹a. b.和罗马子弹（ i ， ii …等）
  • 媒体对媒体URL的支持（YouTube，Vimeo，Mp4 …等）
  • 缩写（灵感来自PHP Markdown Extra-缩写）
  • 引用文本通过封闭\"\"...\"\" （受此常见的讨论的启发）
  • 类似于围栏代码块:::的自定义容器，以生成适当的<div>...</div>而不是此（灵感来自此共同标记讨论）
  • 数字（从这个共同标记的讨论中启发）
  • 页脚（从这个共同标记的讨论中启发）
  • 数学/乳胶扩展通过封闭块的$$和$ for inline Math（灵感来自此共同标志的讨论）
  • 软线作为硬线
  • 表情符号支持（来自Markdown-it的启发）
  • Smartypant （灵感来自大胆的火球 – 智能类动物）
  • Bootstrap类（输出Bootstrap类）
  • 每当围栏代码块包含一个特殊关键字时，图表扩展名，它将转换为具有内容的DIV块（目前，支持mermaid和nomnoml图）
  • YAML前部要解析，而无需评估正面问题并将其从HTML输出中丢弃（通常用于预览，无需在Markdowneditor中没有前提）
  • JIRA链接到自动生成JIRA项目参考的链接（感谢@clarkd：https：//github.com/clarkd/markdigjiralinker）
• 从markdig版本0.20.0+开始， markdig仅与NETStandard 2.0 ， NETStandard 2.1 ， NETCoreApp 2.1和NETCoreApp 3.1兼容。

如果您正在寻找对旧的.NET Framework 3.5或4.0的支持，则可以下载markdig 0.18.3 。

第三方扩展

• WPF/XAML Markdown渲染器： markdig .wpf
• WPF/XAML Markdown渲染器： Neo. markdig .Xaml
• 语法突出显示： markdig .SyntaxHighlighting
• 语法突出显示使用ColorCode-Universal ： Markdown.ColorCode
• 语法突出显示使用Prism.js ： WebStoating. markdig .Prism
• 嵌入式c＃脚本： markdig .Extensions.ScriptCs

文档

存储库正在建设中。在某个时候将有一个专用的网站和适当的文档！

尽管尚未有专用文档，但您可以从规格文档中找到如何使用这些扩展名。

同时，您可以在我的博客文章“为.NET实施Markdown Engine”中的有关markdig的文章“幕后”文章。

下载

markdig可作为Nuget软件包提供：

markdig 。签名的Nuget软件包提供签名的程序集。

用法

API的主要入口点是markdig .Markdown类：

默认情况下，没有任何选项， markdig正在使用普通的CommonMark解析器：

 var result = Markdown . ToHtml ( \"This is a text with some *emphasis*\" ) ;
Console . WriteLine ( result ) ;   // prints: <p>This is a text with some <em>emphasis</em></p>

为了激活大多数高级扩展（表情符号除外，软线，hardline，bootstrap，yaml Front Matter，jiralinks和smart型）

 // Configure the pipeline with all advanced extensions active
var pipeline = new MarkdownPipelineBuilder ( ) . UseAdvancedExtensions ( ) . Build ( ) ;
var result = Markdown . ToHtml ( \"This is a text with some *emphasis*\" , pipeline ) ;

在线尝试！

您可以查看描述所有可操作扩展的MarkdownExtensions（通过修改Markdown Pipeline）

贡献

贡献是使开源社区成为学习，启发和创造的惊人场所的原因。您所做的任何贡献都非常感谢。有关详细的贡献指南，请参阅贡献。

建造

为了构建markdig ，您需要安装.NET 6.0

执照

该软件是根据BSD-CLAUSE 2许可证发布的。

基准测试

最新的基准是在2022年4月23日收集的，该基准是针对以下实施的：

• markdig （版本：0.30.2）：本身
• cmark（版本：0.30.2）：参考c Concommark的实现，不支持扩展
• CONCORMARK.NET（MASTER）（版本：0.15.1）：.NET的CommonMark实现，不支持扩展，Cmark端口，已弃用。
• MarkdownSharp（版本：2.0.5）：开源C＃Markdown处理器的实现，如先前基于REGEXP的堆栈Overflow上所示。

markdig | 1.979 ms | 0.0221 ms | 0.0185 ms |
| cmark | 2.571 ms | 0.0081 ms | 0.0076 ms |
| CommonMark.NET | 2.016 ms | 0.0169 ms | 0.0158 ms |
| MarkdownSharp | 221.455 ms | 1.4442 ms | 1.3509 ms |\”>

 // * Summary *

BenchmarkDotNet=v0.13.1, OS=Windows 10.0.22000
AMD Ryzen 9 5950X, 1 CPU, 32 logical and 16 physical cores
.NET SDK=6.0.202
  [Host]     : .NET 6.0.4 (6.0.422.16404), X64 RyuJIT
  DefaultJob : .NET 6.0.4 (6.0.422.16404), X64 RyuJIT


|            Method |       Mean |     Error |    StdDev |
|------------------ |-----------:|----------:|----------:|
|           markdig |   1.979 ms | 0.0221 ms | 0.0185 ms |
|             cmark |   2.571 ms | 0.0081 ms | 0.0076 ms |
|    CommonMark.NET |   2.016 ms | 0.0169 ms | 0.0158 ms |
|     MarkdownSharp | 221.455 ms | 1.4442 ms | 1.3509 ms |

• markdig大约比Markdownsharp快X100倍
• 比参考cmark C实施快20％

赞助商

通过每月捐款来支持该项目，并帮助我继续改善该项目。 [成为赞助商]

莉莉丝·河（Lilith River），ImageFlow服务器的作者，一部简单的按需图像编辑，优化和交付服务器

学分

感谢John Mac Farlane为Commark Specs所做的出色工作，以及所有参与Markdown的人是更好的标准！

没有这个巨大的基础，这个项目将是不可能的。

还要感谢Project BenchmarkDotnet，该项目使基准测试易于设置！

一些解码部分（例如HTML EntityHelper.cs）已从CommonMark.net重新使用

多亏了@clarkd在JIRA链接扩展程序上完成的工作，该项目现在包含在此项目中！

作者

Alexandre Mutel又名Xooofx