SwiftDown 使用教程

SwiftDown 使用教程

SwiftDown📦 A themable markdown editor component for your SwiftUI apps.项目地址:https://gitcode.com/gh_mirrors/sw/SwiftDown

项目介绍

SwiftDown 是一个可主题化的 Markdown 编辑器组件，专为 SwiftUI 应用设计。它支持内置主题和自定义主题，并提供了在编辑器中直接预览大多数 Markdown 元素的功能，无需基于 Web 的预览。SwiftDown 基于 cmark 构建，确保了快速的渲染速度，并且支持 macOS 和 iOS 平台。

项目快速启动

安装

使用 Swift Package Manager 安装 SwiftDown，可以在 Xcode 中添加包依赖，或者在 Package.swift 文件中添加以下依赖：

dependencies: [
    .package(url: "https://github.com/qeude/SwiftDown.git", from: "0.4.1")
]

使用

在 SwiftUI 项目中使用 SwiftDown 编辑器组件：

import SwiftDown
import SwiftUI
 
struct ContentView: View {
    @State private var text: String = ""
 
    var body: some View {
        SwiftDownEditor(text: $text)
            .insetsSize(40)
            .theme(Theme.BuiltIn.defaultDark.theme())
    }
}

应用案例和最佳实践

内置主题

SwiftDown 提供了两种内置主题：默认暗色和默认亮色。可以通过以下方式应用内置主题：

.theme(Theme.BuiltIn.defaultDark.theme())

自定义主题

SwiftDown 支持通过 JSON 文件自定义主题。首先创建一个自定义主题的 JSON 文件，然后初始化自定义主题：

let themePath = Bundle.main.path(forResource: "my-custom-theme", ofType: "json")
let customTheme = Theme(themePath: themePath)

典型生态项目

SwiftDown 作为一个 Markdown 编辑器组件，可以与其他 SwiftUI 项目结合使用，例如：

• 笔记应用：使用 SwiftDown 作为笔记应用的编辑器，支持 Markdown 格式，提供丰富的编辑和预览功能。
• 文档编辑器：在文档编辑器中集成 SwiftDown，使用户能够使用 Markdown 语法快速编写和格式化文档。
• 博客平台：在博客平台中使用 SwiftDown 作为文章编辑器，支持 Markdown 语法，方便作者快速发布内容。

通过这些应用案例，SwiftDown 展示了其在不同类型应用中的灵活性和实用性。

SwiftDown📦 A themable markdown editor component for your SwiftUI apps.项目地址:https://gitcode.com/gh_mirrors/sw/SwiftDown