Moonisky / SwiftMarkdownParser

A Swift Wrapper of the Sundown Markdown Library

MarkdownParseKit

A Swift Wrapper of the Sundown Markdown Library.

The aim of this framework is to provide the basic functionality that sundown provides alongside the possibility to do stuff quickly (simple API).

And it also gives developers the option to load Markdown instead of HTML, and specify a stylesheet.

Because it's implemented by C, so I recommend you use CocoaPods or dynamic Framework for maintaining the pure Swift.

---

这是一个对 Sundown Markdown 解析库的 Swift 封装库。

这个框架的目标在于给 Swift 的使用者提供 Sundown 所提供的基本功能，以便大家能够快速、便捷地进行 markdown 解析工作。

此外，这个框架还给开发者们提供了一项功能，允许加载 Markdown 文本，并且指定一个样式表。

由于 Sundown 的底层由 C 实现，因此我建议您使用 CocoaPods 或者动态框架进行安装，以维持 Swift 的代码纯净度。

---

##Example

Convert Markdown to HTML

let markdown = "# How to Write Markdown\n* Start with some bullet points\n* Crucially, you want to **emphasis** the _important_ points"
print(markdown)

print("===================")

let parser = MarkdownParse.convertMarkdownString(markdown)
print(parser)

The results in Console are:

控制台当中的结果为：

# How to Write Markdown
* Start with some bullet points
* Crucially, you want to **emphasis** the _important_ points
===================
<h1>How to Write Markdown</h1>

<ul>
<li>Start with some bullet points</li>
<li>Crucially, you want to <strong>emphasis</strong> the <em>important</em> points</li>
</ul>

Load Markdown

This simple functionality is provided by Extension. Want to load some Markdown on a UIWebView / WKWebView instad of HTML? It's depend on your requirement. You can see the example below:

这个简单的功能是由扩展实现的。想要让 UIWebView 或者 WKWebView 加载 Markdown 而不是加载 HTML 么？ 这完全取决于您的需求。您可以参考下面的示例：

import UIKit
import MarkdownParseKit

class ViewController: UIViewController {
  func viewDidLoad() {
  	super.viewDidLoad()

    webview.loadMarkdownString("# How to Write Markdown\n* Start with some bullet points\n* Crucially, you want to **emphasis** the _important_ points")
  }
}

In short, that's all you need to get started.

总而言之，这就是这个框架的全部内容。

###Requirements

• iOS 8.0+

If you want to support iOS 7, you should use my source code for using this functionality. Because it does not allow using 3rd party dynamic frameworks, and it's impossible to build static libraries that contain Swift code.

• Swift 2.0

• Xcode 7.0+

##Install

###CocoaPods

Because of the GFW, MarkdownParseKit is Not available through CocoaPods yet, I'm still struggling for supporting.

To install it, you should:

• Install CocoaPods 0.39.0 or later.

• In your Podfile, add use_frameworks! and pod 'MarkdownParseKit' to your main and test targets.

• From the command line, run pod install.

• Use the .xcworkspace file generated by CocoaPods to work on your project!

---

由于众所周知的原因，MarkdownParseKit 目前暂时不可以通过 CocoaPods 来安装。

要安装它的话，您应当：

• 安装 CocoaPods 0.39.0 及其以上版本；
• 在您的 Podfile 文件中，在您的 Target 中添加 use_frameworks! 以及 pod 'MarkdownParseKit' 这两条语句；
• 在命令行当中，运行 pod install；
• 使用由 CocoaPods 生成的 .xcworkspace 文件来进行您的项目工作！

###Carthage

MarkdownParseKit is also available through Carthage.

To install it, you should:

• Install Carthage 0.10.2 or later.
• Add github "SemperIdem/SwiftMarkdownParser" to your Cartfile.
• Run carthage update.
• Drag MarkdownParseKit.framework from the appropriate platform directory in Carthage/Build to the Embedded Binaries section of your Xcode project's "General" settings.

---

MarkdownParseKit 还可以通过 Carthage 安装。

要安装它的话，您应当：

• 安装 Carthage 0.10.2 及其以后版本；
• 向您的 Cartfile 中添加 github "SemperIdem/SwiftMarkdownParser"；
• 运行 carthage update；
• 从 Carthage/Build 中相应的平台文件夹内的 MarkdownParseKit.framework 文件，拖曳到您 Xcode 项目中 "General" 设置的 Embedded Binaries 栏目当中。

###Embedded Framework

• Download the latest release of MarkdownParseKit and extract the zip.
• Go to your Xcode project's "General" settings. Drag MarkdownParseKit.framework from Frameworks directory to the "Embedded Binaries" section. Make sure Copy items if needed is selected.

---

• 下载 MarkdownParseKit 的最新发布版本，然后解压文件。
• 前往您 Xcode 项目中的 "General" 设置选项当中。将 Frameworks 目录中的 MarkdownParseKit.framework 文件拖入到 "Embedded Binaries" 栏目当中。请确保 Copy items if needed 被选中。

Sources

• Clone MarkdownParseKit from my repository on Github.

• Drag Sundown folder and SundownWrapper.swift to your projects.

• If you don't have a Swift Bridge Header, please create one. You can find the tutorials on Google.

• In your Bridge Header, paste the following snippet in your file:

#include "markdown.h"
#include "html.h"

---

• 用 git 命令将我 Github 上的 MarkdownParseKit 仓库拷贝下来；

• 将 Sundown 文件夹以及 SundownWrapper.swift 文件拖曳到您的项目当中；

• 如果您没有 Swift 桥接头文件 的话，那么请创建一个。您可以在百度上找到创建此头文件的教程。

• 在您的 桥接头文件 当中，将下列代码复制到您的文件当中：

#include "markdown.h"
#include "html.h"

License

The wrapper is available under the MIT license. Note that the actual library is not licensed under the MIT license.

这个封装库是基于 MIT 协议开源的。大家要注意的是，Sundown 库并不是基于 MIT 协议开源的。

See the LICENSE file for more info.