This repository has been archived by the owner on Jun 23, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 25
/
README.md
125 lines (96 loc) · 4.13 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<p align="center">
<a href="https://travis-ci.org/EFPrefix/EFMarkdown">
<img src="http://img.shields.io/travis/EFPrefix/EFMarkdown.svg">
</a>
<a href="http://cocoapods.org/pods/EFMarkdown">
<img src="https://img.shields.io/cocoapods/v/EFMarkdown.svg?style=flat">
</a>
<a href="http://cocoapods.org/pods/EFMarkdown">
<img src="https://img.shields.io/cocoapods/p/EFMarkdown.svg?style=flat">
</a>
<a href="https://raw.githubusercontent.com/EFPrefix/EFMarkdown/master/LICENSE">
<img src="https://img.shields.io/cocoapods/l/EFMarkdown.svg?style=flat">
</a>
<a href="https://twitter.com/EyreFree777">
<img src="https://img.shields.io/badge/twitter-@EyreFree777-blue.svg?style=flat">
</a>
<a href="http://weibo.com/eyrefree777">
<img src="https://img.shields.io/badge/weibo-@EyreFree-red.svg?style=flat">
</a>
<img src="https://img.shields.io/badge/made%20with-%3C3-orange.svg">
</p>
EFMarkdown is a lightweight Markdown library in Swift, based on [EFCMark](https://github.com/EFPrefix/EFCMark), inspired by [markdown](https://github.com/vapor-community/markdown) and [Markoff](https://github.com/thoughtbot/Markoff).
> [中文介绍](https://github.com/EFPrefix/EFMarkdown/blob/master/README_CN.md)
## Overview
sample1|sample2|sample3|sample4
:---------------------:|:---------------------:|:---------------------:|:---------------------:
|||
## Example
To run the example project, clone the repo, and run `pod install` from the Example directory first.
## Requirements
| Version | Needs |
|:---------|:------------------------------------------------|
| 0.x | XCode 8.0+<br>Swift 3.0+<br>iOS 8.0+ |
| 4.x | XCode 9.0+<br>Swift 4.0+<br>iOS 8.0+ |
| 5.x | XCode 10.2+<br>Swift 5.0+<br>iOS 8.0+ |
## Installation
EFMarkdown is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod "EFMarkdown"
```
## Usage
### 1. Markdown to HTML
You can use `EFMarkdown` to make Markdown string to HTML string easily:
```swift
let markdown = "# Hello"
var html = ""
do {
html = try EFMarkdown().markdownToHTML(markdown, options: EFMarkdownOptions.safe)
print(html) // This will return "<h1>Hello</h1>\n"
} catch let error as NSError {
print ("Error: \(error.domain)")
}
```
### 2. View Markdown
You can use `EFMarkdownView` to make a preview of Markdown:
```swift
let screenSize = UIScreen.main.bounds
let markView = EFMarkdownView()
markView.frame = CGRect(x: 0, y: 20, width: screenSize.width, height: screenSize.height - 20)
markView.onRendered = {
[weak self] (height) in
if let _ = self {
// Optional: you can know the change of height in this block
print("onRendered height: \(height ?? 0)")
}
}
self.view.addSubview(markView)
markView.load(markdown: testMarkdownFileContent(), options: [.default]) {
[weak self] (_, _) in
if let _ = self {
// Optional: you can change font-size with a value of percent here
markView.setFontSize(percent: 128)
printLog("load finish!")
}
}
```
### 3. Options
You can pass different options to the underlying `cmark` library. By default `safe` is passed.
The available options are:
* default
* sourcePos
* hardBreaks
* safe
* noBreaks
* validateUTF8
* smart
* githubPreLang
* liberalHtmlTag
For more information on the available options, see [`cmark`](https://github.com/github/cmark).
## Author
EyreFree, eyrefree@eyrefree.org
## License
<img src='http://www.wtfpl.net/wp-content/uploads/2012/12/logo-220x160.png' width='110' height='80'/>
EFMarkdown is available under the WTFPL license. See the LICENSE file for more info.