forked from mittsu333/MarkedView-for-iOS
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
51 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,67 @@ | ||
# MarkedView | ||
## MarkedView Example | ||
--- | ||
|
||
|
||
## Introduction | ||
--- | ||
|
||
The MarkedView is the markdown text viewer. | ||
|
||
select the best one from UIWebview or WKWebview. | ||
|
||
* UIMarkedView | ||
* UIWebView base | ||
|
||
|
||
* WKMarkedView | ||
* WKWebView base | ||
|
||
[![CI Status](http://img.shields.io/travis/mittsu/MarkedView.svg?style=flat)](https://travis-ci.org/mittsu/MarkedView) | ||
[![Version](https://img.shields.io/cocoapods/v/MarkedView.svg?style=flat)](http://cocoapods.org/pods/MarkedView) | ||
[![License](https://img.shields.io/cocoapods/l/MarkedView.svg?style=flat)](http://cocoapods.org/pods/MarkedView) | ||
[![Platform](https://img.shields.io/cocoapods/p/MarkedView.svg?style=flat)](http://cocoapods.org/pods/MarkedView) | ||
|
||
## Usage | ||
--- | ||
|
||
The same process except the initialization. | ||
|
||
Call is available from any text from any file . | ||
|
||
``` | ||
import MarkedView | ||
To run the example project, clone the repo, and run `pod install` from the Example directory first. | ||
・・・ | ||
// WKWebView base | ||
let mdView = WKMarkedView() | ||
// view set | ||
self.view = mdView | ||
// set Markdown text pattern | ||
mdView.textToMark(contents) | ||
// or load Markdown file pattern | ||
// mdView.loadFile(filePath) | ||
``` | ||
|
||
## Requirements | ||
|
||
## Installation | ||
--- | ||
|
||
MarkedView is available through [CocoaPods](http://cocoapods.org). To install | ||
it, simply add the following line to your Podfile: | ||
MarkedView is available through [CocoaPods](https://cocoapods.org/). | ||
|
||
```ruby | ||
pod "MarkedView" | ||
To install it, simply add the following line to your ``` Podfile ```: | ||
|
||
|
||
``` | ||
pod 'MarkedView' | ||
``` | ||
|
||
## Author | ||
Then run the following command: | ||
|
||
mittsu, [email protected] | ||
``` | ||
$ pod install | ||
``` | ||
|
||
## License | ||
--- | ||
|
||
MarkedView is available under the MIT license. See the LICENSE file for more info. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.