MarkdownKit 使用教程

项目介绍

MarkdownKit 是一个为 iOS 和 macOS 设计的可定制和可扩展的 Markdown 解析器。它通过使用正则表达式支持许多标准的 Markdown 元素。MarkdownKit 还允许自定义字体和颜色属性，适用于所有 Markdown 元素。

项目快速启动

安装

通过 CocoaPods 安装

在你的 Podfile 中添加以下行：

pod 'MarkdownKit'

然后运行：

pod install

通过 Swift Package Manager 安装

在你的 Package.swift 文件中添加以下依赖：

dependencies: [
    .package(url: "https://git.example.com/bmoliveira/MarkdownKit.git", from: "1.7.0")
]

使用示例

以下是一个简单的使用示例，展示如何将 Markdown 文本转换为 NSAttributedString：

import MarkdownKit

let markdownParser = MarkdownParser()
let markdown = "**Hello** *World*!"
let attributedString = markdownParser.parse(markdown)

let label = UILabel()
label.attributedText = attributedString

应用案例和最佳实践

自定义 Markdown 元素

MarkdownKit 允许你自定义 Markdown 元素。以下是一个自定义的论坛版块元素的示例：

import MarkdownKit

class MarkdownForumSection: MarkdownElement {
    let regex = "\\[f/([a-zA-Z0-9_]+)\\]"

    func match(_ match: NSTextCheckingResult, attributedString: NSMutableAttributedString) {
        let sectionName = attributedString.attributedSubstring(from: match.range(at: 1)).string
        let linkURLString = "http://forum.example.com/f/\(sectionName)"
        formatText(attributedString, range: match.range, link: linkURLString)
        addAttributes(attributedString, range: match.range, link: linkURLString)
    }
}

let markdownParser = MarkdownParser(customElements: [MarkdownForumSection()])
let markdown = "**/f/iosprogramming** can be *markdown* as well."
let label = UILabel()
label.attributedText = markdownParser.parse(markdown)

典型生态项目

MarkdownKit 可以与其他文本处理和显示库结合使用，例如：

• UITextView+Markdown: 一个扩展，允许在 UITextView 中直接显示 Markdown 文本。
• Down: 另一个 Swift 实现的 Markdown 解析器，可以与 MarkdownKit 结合使用，提供更丰富的 Markdown 解析功能。

通过这些组合，你可以在 iOS 和 macOS 应用中实现强大的 Markdown 处理和显示功能。