CommonMarkAttributedString 项目教程

1. 项目的目录结构及介绍

CommonMarkAttributedString 是一个将 CommonMark 格式的 Markdown 文本转换为 NSAttributedString 的 Swift 库。以下是该项目的目录结构及其介绍：

CommonMarkAttributedString/
├── .github/
│   └── workflows/
│       └── swift.yml
├── Sources/
│   └── CommonMarkAttributedString/
│       ├── CommonMarkAttributedString.swift
│       ├── Document.swift
│       ├── Node.swift
│       ├── Parser.swift
│       └── Visitor.swift
├── Tests/
│   └── CommonMarkAttributedStringTests/
│       ├── CommonMarkAttributedStringTests.swift
│       └── XCTestManifests.swift
├── .gitignore
├── .swift-version
├── LICENSE
├── Package.swift
├── README.md

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件，用于自动化构建和测试。
• Sources/CommonMarkAttributedString/: 包含项目的主要源代码文件。
  • CommonMarkAttributedString.swift: 主文件，包含将 CommonMark 转换为 NSAttributedString 的核心逻辑。
  • Document.swift: 处理文档级别的操作。
  • Node.swift: 定义 Markdown 节点的数据结构。
  • Parser.swift: 负责解析 Markdown 文本。
  • Visitor.swift: 实现访问者模式，用于遍历和处理节点。
• Tests/CommonMarkAttributedStringTests/: 包含项目的单元测试文件。
  • CommonMarkAttributedStringTests.swift: 单元测试的主要文件。
  • XCTestManifests.swift: 测试清单文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• .swift-version: 指定 Swift 版本。
• LICENSE: 项目的许可证。
• Package.swift: Swift 包管理器的配置文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 Sources/CommonMarkAttributedString/CommonMarkAttributedString.swift。这个文件包含了库的主要入口点，提供了将 CommonMark 格式的 Markdown 文本转换为 NSAttributedString 的功能。

主要功能

• 初始化方法: 提供了一个初始化方法，接受 CommonMark 格式的字符串并返回 NSAttributedString。
• 核心转换逻辑: 实现了从 CommonMark 到 NSAttributedString 的转换逻辑。

3. 项目的配置文件介绍

项目的配置文件主要是 Package.swift。这个文件是 Swift 包管理器的配置文件，定义了项目的依赖关系、目标和其他配置。

主要内容

• 名称: 定义了包的名称。
• 产品: 定义了包提供的产品（库或可执行文件）。
• 依赖: 列出了项目依赖的其他包。
• 目标: 定义了项目的源代码目录和测试目录。

// swift-tools-version:5.3
import PackageDescription

let package = Package(
    name: "CommonMarkAttributedString",
    products: [
        .library(
            name: "CommonMarkAttributedString",
            targets: ["CommonMarkAttributedString"]),
    ],
    dependencies: [
        .package(url: "https://github.com/SwiftDocOrg/CommonMark.git", from: "0.5.0"),
    ],
    targets: [
        .target(
            name: "CommonMarkAttributedString",
            dependencies: ["CommonMark"]),
        .testTarget(
            name: "CommonMarkAttributedStringTests",
            dependencies: ["CommonMarkAttributedString"]),
    ]
)

配置文件介绍

• 名称: 项目的名称为 CommonMarkAttributedString。
• 产品: 提供了一个库产品，名称为 CommonMarkAttributedString。
• 依赖: 依赖于 CommonMark 包，版本从 0.5.0 开始。
• 目标: 定义了两个目标，一个是主目标 CommonMarkAttributedString，另一个是测试目标 CommonMarkAttributedStringTests。

通过这些配置，Swift 包管理器可以自动处理依赖关系、构建和