转载

[iOS] Marklight：Markdown 语法高亮显示编辑库

Marklight

Markdown syntax highlighter for iOS.

Description

Marklight is a drop in component to easily add realtime markdown syntax highlight on any user editable text view on iOS applications. Marklight doesn't include html generation from markdown, but you can use one of the many other components available likeMarkingbird.

Regular expressions are taken fromMarkingbird: markdown parser and html generator.

[iOS] Marklight：Markdown 语法高亮显示编辑库

Features

Applicable to any UITextView .
NSTextStorage subclass ready to use.
Struct optimized for performances.
Swift 2.1 compatible.
Dynamic text style supported.
Choose markdown syntax color.
Choose font and color for code blocks.
Choose font and color for quotes.
Choose dynamic type font text style.
Quote indentation.
Documented.
Parsing tests.
Performance tests.
OS X compatibility.

Requirements

iOS 8.0+
Xcode 7.2+

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

CocoaPods 0.39.0+ is required to build Marklight.

To integrate Marklight into your Xcode project using CocoaPods, specify it in your Podfile :

source 'https://github.com/CocoaPods/Specs.git' platform :ios, '8.0' use_frameworks!  pod 'Marklight'

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can installCarthage with Homebrew using the following command:

$ brew update $ brew install carthage

To integrate Marklight into your Xcode project usingCarthage, specify it in your Cartfile :

github "macteo/Marklight"

Run carthage update --platform iOS to build the framework and drag the built Marklight.framework into your Xcode project.

Manually

Add the Marklight Xcode project to your own. Then add the Marklight framework as desired to the embedded binaries of your app's target.

Usage

In this repository you can find a sample project with few lines of code in the ViewController class for a jumpstart.

Sample code is written in Swift but Objective-C should be supported too, if you find an incompatibility please open an issue.

Integration

The easiest way to crete a user editable UITextView with markdown syntax highlight is to use the provided MarklightTextStorage class as NSTextStorage and add the UITextView 's textLayout to the MarklightTextStorage text storage.

Import Marklight modules into your Swift class

import Marklight

or if you are writing in Objective-C

#import <Marklight/Marklight-Swift.h>

Keep in mind the you have to let the project generate the Bridging Header otherwise the integration may fail.

In your UIViewController subclass keep a strong instance of the this MarklightTextStorage class.

let textStorage = MarklightTextStorage()

Customize the appearance as desired:

Dynamic text style.
Markdown syntax color.
Code's font and color.
Quotes' font and color.

As per Apple's documentation it should be enough to assign the UITextView 's NSLayoutManager to the NSTextStorage subclass, in our case MarklightTextStorage .

textStorage.addLayoutManager(textView.layoutManager)

However I'm experiencing some crashes if I want to preload some text instead of letting the user start from scratch with a new text. A workaround is proposed below.

For simplicity we assume you have a String to be highlighted inside an editable UITextView loaded from a storyboard.

let string = "# My awesome markdown string"

Convert string to an NSAttributedString

let attributedString = NSAttributedString(string: string)

Set the loaded string to the UITextView

textView.attributedText = attributedString

Append the loaded string to the NSTextStorage

textStorage.appendAttributedString(attributedString)

Enjoy.

Acknowledgements

Matteo Gavagnin – @macteo

Marklight is heavily based onMarkingbird, so many thanks to Kristopher Johnson and every previous contribution on whichMarkingbird is based upon.

License

Marklight is released under the MIT license. See LICENSE for details.

原文 https://github.com/macteo/Marklight

正文到此结束

所属分类：编程技术

本文标签： http git IDE iText ECS struct UI Document DDL ip cat parse src tab description HTML build update find App ORM tar Apple Swift Features GitHub CocoaPods IOS https NSA dependencies
版权声明： 本文为互联网转载文章，出处已在文章中说明(部分除外)。如果侵权，请联系本站长删除，谢谢。
本文海报： 生成海报一生成海报二

[iOS] Marklight：Markdown 语法高亮显示编辑库

Marklight

Description

Features

Requirements

Installation

CocoaPods

Carthage

Manually

Usage

Integration

Acknowledgements

License

热门推荐

相关文章

说给你听

本文目录

随机标签

书籍教程

近期评论

网站信息

其他链接

关于本站

问题交流