Markdowner 2.0.0

Markdowner 2.0.0

Reynaldo Aguilar 维护。



  • By
  • rlaguilar

Markdowner

CI Status Version License Platform

Markdowner 是一个旨在实时编辑和预览 Markdown 的库。它支持自定义 Markdown 元素或仅使用标准的子集。同时也支持自定义字体和颜色。

Preview of Library Demo

示例

要运行示例项目,首先克隆仓库,然后从 Example 目录运行 pod install

要求

需要 iOS 10 或更高版本和 Swift 4.1 或更高版本。

安装

Markdowner 通过 CocoaPods 提供。要安装它,只需将以下行添加到您的 Podfile 中

pod 'Markdowner'

如何使用

使用 Markdowner 的主要入口是使用自定义类型 MarkdownTextView,它是 UITextView 的一个子类。

var textView = MarkdownTextView(frame: parentView.bounds)
parentView.addSubview(textView)
textView.frame = ... // setup text view position inside its parent
textView.text = ... // set the initial markdown to display, if any

如果您想自定义markdown元素的默认外观,可以使用类 StylesConfiguration

textView.stylesConfiguration = StylesConfiguration(
    baseFont: UIFont.systemFont(ofSize: 18),
    textColor: UIColor.darkGray,
    symbolsColor: UIColor.red
)

创建自定义元素与子类化类型 MarkdownElement 一样简单,然后调用函数 textView.use(elements: [MarkdownElement]),将要使用的markdown元素列表作为参数传递。作为创建新元素的指导,您可以使用文件夹中已经实现的任何已经实现的元素 Markdowner/Classes/Default Elements

需要注意的是,目前 Markdowner 不支持从Storyboard进行初始化。

作者

rlaguilar, [email protected]

许可

Markdowner 在 MIT 许可下提供。有关更多信息,请参阅 LICENSE 文件。