indragiek / markdowntextview Goto Github PK

Rich Markdown editing control for iOS

License: MIT License

Swift 96.10% Ruby 2.07% Objective-C 1.83%

markdowntextview's Introduction

MarkdownTextView

Rich Markdown Editing for iOS

MarkdownTextView is an iOS framework for adding rich Markdown editing capabilities. Support for Markdown syntax is implemented inside an easily extensible NSTextStorage subclass, with a UITextView subclass being provided for convenience.

Screenshot

Example App

Check out the includeded Example app to try out the text view and to see how MarkdownTextView is integrated into the project.

Installation

With CocoaPods:

pod "MarkdownTextView"

With Carthage:

github "indragiek/MarkdownTextView"

Getting Started

The simplest possible usage is as follows:

let textView = MarkdownTextView(frame: CGRectZero)
view.addSubview(textView)

This gives you a text view with support for most of the features defined in the original Markdown implementation (strong, emphasis, inline code, code blocks, block quotes, headers) with the default styling provided by the framework.

Customizing Appearance

All of the styling can be customized using standard NSAttributedString attributes. For example, if you wanted to customize bold text such that it appeared red, you would do this:

var attributes = MarkdownTextAttributes()
attributes.strongAttributes = [
	NSForegroundColorAttributeName: UIColor.redColor()
]
let textStorage = MarkdownTextStorage(attributes: attributes)
let textView = MarkdownTextView(frame: CGRectZero, textStorage: textStorage)
view.addSubview(textView)

Extensions Support

Extension classes conforming to the HighlighterType protocol can be used to add support for unofficial Markdown extensions. The framework comes with the following extensions already implemented:

From Github Flavored Markdown:

MarkdownStrikethroughHighlighter - Support for ~~strikethrough~~
MarkdownFencedCodeHighlighter - Support for fenced code blocks
LinkHighlighter - Support for auto-linking

Other:

MarkdownSuperscriptHighlighter - Support for super^scripted^text

These extensions do not come activated by default. They must manually be added to an instance of MarkdownTextStorage as follows:

let textStorage = MarkdownTextStorage()
var error: NSError?
if let linkHighlighter = LinkHighlighter(errorPtr: &error) {
    textStorage.addHighlighter(linkHighlighter)
} else {
    assertionFailure("Error initializing LinkHighlighter: \(error)")
}
textStorage.addHighlighter(MarkdownStrikethroughHighlighter())
textStorage.addHighlighter(MarkdownSuperscriptHighlighter())
if let codeBlockAttributes = attributes.codeBlockAttributes {
    textStorage.addHighlighter(MarkdownFencedCodeHighlighter(attributes: codeBlockAttributes))
}

let textView = MarkdownTextView(frame: CGRectZero, textStorage: textStorage)
view.addSubview(textView)

Credits

John Gruber's original Markdown implementation for most of the regular expressions used in this project.
RFMarkdownTextView for the idea to implement this as an NSTextStorage subclass

Contact

Indragie Karunaratne
@indragie
http://indragie.com

License

MarkdownTextView is licensed under the MIT License. See LICENSE for more information.

markdowntextview's People

Contributors

Stargazers

Watchers

markdowntextview's Issues

Swift 3

Hy, I am using your framework in my application.

Now I was wondering if you plan to port your component to swift 3.

How do I add Markdown to a UITextView which has been added in the storyboard ?

 @IBOutlet weak var texView:  MarkdownTextView!
  var textStorage: MarkdownTextStorage?

  let attributes = MarkdownAttributes()
        let textStorage = MarkdownTextStorage(attributes: attributes)
        do {
            textStorage.addHighlighter(try LinkHighlighter())
        } catch let error {
            fatalError("Error initializing LinkHighlighter: \(error)")
        }
        textStorage.addHighlighter(MarkdownStrikethroughHighlighter())
        textStorage.addHighlighter(MarkdownSuperscriptHighlighter())
        if let codeBlockAttributes = attributes.codeBlockAttributes {
            textStorage.addHighlighter(MarkdownFencedCodeHighlighter(attributes: codeBlockAttributes))
        }



.....

Automatically number ordered list items

When pressing return from an ordered list item, the next item should be automatically numbered with the next number in the sequence.

Pasting Markdown Text then crash

I created some md texts in this view. When I copy some md text then paste at the first line of the text area, it crashes with the following message:

2017-10-06 08:06:36.430585+0200 xxx[59886:2281740] /Users/clear/Dropbox/dev/Traces/libs/MarkdownTextView-master/MarkdownTextView/MarkdownTextStorage.swift: 14: 12: fatal error: use of unimplemented initializer 'init()' for class 'MarkdownTextView.MarkdownTextStorage'

Bold and italic at the same time

Doesn't work right now:

Possible memory leak issues

Because it cannot handle 600kb of text (consumes over 700mb of memory and crashes)

Swift 2.0 support

I had to refactor a bunch of the code, to use with my project in Swift 2.0. You should make this compliant with that standard.

Images

Support for rendering embedded images.

Fatal error: Use of unimplemented initializer 'init()' for class 'MarkdownKit.MarkdownTextStorage'

Error when using copy and paste

fatal error: value failed to bridge from Swift type to a Objective-C type

I get an error when changing the default text attributes, any help on how to change the default text font ?

Memory Leak

Causes ~50 memory leaks in its current state.

My code for reference:

lazy var composeTextView: MarkdownTextView = {

  // MarkdownTextView
    var attributes = MarkdownAttributes()
    attributes.defaultAttributes = [
        NSFontAttributeName: UIFont.systemFont(ofSize: constants.compose.textFontSize),
        NSForegroundColorAttributeName: constants.compose.textFontColor
    ]
    
    let textStorage = MarkdownTextStorage(attributes: attributes)
    do {
        textStorage.addHighlighter(try LinkHighlighter())
    } catch let error {
        fatalError("Error initializing LinkHighlighter: \(error)")
    }
    textStorage.addHighlighter(MarkdownStrikethroughHighlighter())
    textStorage.addHighlighter(MarkdownSuperscriptHighlighter())
    if let codeBlockAttributes = attributes.codeBlockAttributes {
        textStorage.addHighlighter(MarkdownFencedCodeHighlighter(attributes: codeBlockAttributes))
    }
    
    let textView = MarkdownTextView(frame: CGRect.zero, textStorage: textStorage)
    //textView.font = UIFont.systemFont(ofSize: constants.compose.textFontSize)
    //textView.textColor = constants.compose.textFontColor
    textView.backgroundColor = .clear
    //textView.textColor = constants.compose.textFontColor
    textView.font = UIFont.systemFont(ofSize: constants.compose.textFontSize)
    //textView.tintColor = constants.compose.textFontColor
    textView.textContainerInset = UIEdgeInsets(top: 5, left: 9, bottom: constants.compose.helpButton.padding, right: 9)
    
    textView.isEditable = true
    textView.isSelectable = true
    textView.isScrollEnabled = true
    textView.showsVerticalScrollIndicator = false
    textView.showsHorizontalScrollIndicator = false
    
    textView.keyboardAppearance = UIKeyboardAppearance.light
    
    // testing purposes
    textView.layer.borderWidth = constants.testingBorderWidth
    textView.layer.borderColor = UIColor.red.cgColor
    
    return textView
}()