GFMarkdown

从标准 Markdown 内容轻松渲染 HTML。

概述

使用此库从包含 GitHub Flavored Markdown (GFM) / CommonMark 内容的字符串生成 HTML。

例如，此代码

# Hello
Hello, _World_!

将被翻译成此代码

<h1>Hello</h1>
<p>Hello, <em>World<em>!</p>

致谢

此实现完全构建于出色的 cmark-gfm 之上，而 cmark-gfm 本身又是优秀 cmark 的一个分支。

基本用法

只需使用 GFMarkdown 包装您的 Markdown 字符串，并调用 GFMarkdown/toHTML(options:extensions:)，无需任何参数。

let html = GFMarkdown("# Hello").toHTML()
print(html) // "<h1>Hello</h1>"

文档

完整的 DocC 格式文档可以在每个相应的版本中找到。例如，这里。

配置您的项目

查找附加到每个版本的相应 XCFramework，并将其作为二进制目标添加到您的 Package.swift 中。下面的示例包含当前分支/版本的正确 URL 和校验和。

…
let package = Package(
    …
    dependencies: [
        .package(name: "GFMarkdown", url: "https://github.com/swiftysites/gfmarkdown", branch: "release")
    ],
    targets: [
        .target(
            name: "MyApp",
            dependencies: ["GFMarkdown"])
    ]
    …
)