mar

MarkedView

The MarkedView is the markdown text viewer

Showing:

Popularity

Downloads/wk

0

GitHub Stars

54

Maintenance

Last Commit

3yrs ago

Contributors

5

Package

Dependencies

0

License

MIT

Categories

Readme

MarkedView

Version License Platform codebeat badge

img_gif

Introduction

The MarkedView is the markdown text viewer.

select the best one from UIWebview or WKWebview.

  • UIMarkedView
    • UIWebView base
  • WKMarkedView
    • WKWebView base

Usage

It is a simple module, which enable you to convert any files into initialized view.

// Swift
import MarkedView

・・・

// WKWebView base
let mdView = WKMarkedView()
// delegate
mdView.delegate = self

// code block in scrolling be deactivated.
// mdView.setCodeScrollDisable()

// view set
self.view = mdView

// set Markdown text pattern ('contents' object is markdown text)
mdView.textToMark(contents)

// load Markdown file pattern
// mdView.loadFile(filePath)

Delegate

  • UIMarkViewDelegate (UIMarkedView)
  • WKMarkViewDelegate (WKMarkedView)

Example

extension UIMarkedController: UIMarkViewDelegate {

    func markViewRedirect(url: URL) {
        if #available(iOS 9.0, *) {
            let safari = SFSafariViewController(url: url)
            self.present(safari, animated: true, completion: nil)

        } else {
            if(UIApplication.shared.canOpenURL(url)) {
                UIApplication.shared.openURL(url)
            }
        }
    }
}

Delegate Method

  • Function to detect link is fingered in page
    • optional func markViewRedirect(url: URL)

Installation

MarkedView is available through CocoaPods.

To install it, simply add the following line to your Podfile:

// Swift 3.0
pod 'MarkedView', '~> 1.1.2'

Then run the following command:

$ pod install

See Also

Credits

This used the following open source components.

Marked : Markdown parser written in JavaScript

highlight.js : Syntax highlighting for the Web

Requirements

  • v1.0.0 ~ v1.0.4

    • iOS 8.3+
    • Swift 2.2
    • Xcode 7.3+
  • v1.0.5~

    • iOS 8.0+
    • Swift 2.3
    • Xcode 8.0
  • v1.1.0~

    • iOS 8.0+
    • Swift 3.0
    • Xcode 8.0

License

MarkedView is available under the MIT license. See the LICENSE file for more info.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100