Swift Markdown Kit · DOCS
安装
安装
1. 拿到文件
购买后,账户中心 里 SDK 压缩包可以直接下载。授权文件多一步:绑定 之后才会生成。
- 打开 Team ID 授权文件 面板。
- 填入你的 Apple Team ID —— Apple Developer 账户里那个 10 位标识,形如
ABCDE12345。 - 确认。签名后的
.smklicense会立即生成并可下载。
确认前请核对 Team ID。 授权是离线校验的签名文件,签发后无法回收,因此 绑定之后不能自助更改。填错了请联系支持。
两个文件都可以随时重新下载;在更新窗口内升级 SDK 不需要重新签发授权。
2. 加入 framework
- 解压后,把
SwiftMarkdownKit.xcframework拖进 Xcode 工程。 - 选中 App target。
- 在 General › Frameworks, Libraries, and Embedded Content 里把它设为 Embed & Sign。
Framework 开启了 library evolution,因此从 Xcode 16 起的任何 Swift 编译器版本 都能直接链接,不需要我们重新出包。
3. 加入授权文件
把 .smklicense 拖进工程,并确认它出现在 App target 的
Build Phases › Copy Bundle Resources 里。
没有激活码,也没有需要粘进源码的 SDK key。授权就是 SDK 从你的 bundle 里读取的 一个签名文件,完全在设备上离线校验 —— 不会向任何服务器发请求,所以你的 App 不会因为我们的服务出问题而受影响。
4. 导入并渲染
import SwiftUI
import SwiftMarkdownKit
struct ReadmeView: View {
var body: some View {
MarkdownRenderView(markdown: "# Hello\n\n它 **能用**。")
}
}
无论用哪种方式引入,模块名都是 SwiftMarkdownKit。
用 Swift Package Manager 引入
如果你的工程更习惯用包而不是嵌入 framework,把下载到的 xcframework 包一层本地 package 即可:
// swift-tools-version: 5.9
import PackageDescription
let package = Package(
name: "SwiftMarkdownKitBinary",
platforms: [.iOS(.v17)],
products: [
.library(name: "SwiftMarkdownKit", targets: ["SwiftMarkdownKit"])
],
targets: [
.binaryTarget(
name: "SwiftMarkdownKit",
path: "SwiftMarkdownKit.xcframework"
)
]
)
把这个目录作为本地 package 加进 workspace,然后依赖 SwiftMarkdownKit 产物。
本地 binary target 不需要 checksum,并且锁定的就是你仓库里那个二进制。
验证是否装好
开发期打印一次诊断:
print(MarkdownRenderKit.version)
print(MarkdownRenderKit.licenseDiagnostics())
授权生效时,第一行会显示 licensed …… true。没生效时,同一份输出会直接说明
原因 —— 对照 授权。
无论授权是否生效,渲染都能正常工作。没有授权只是被打角标,不会被破坏。