frenya/MMMarkdown

An Objective-C static library for converting Markdown to HTML.

MMMarkdown

MMMarkdown is an Objective-C static library for converting Markdown to HTML. It is compatible with OS X 10.6+ and iOS 5.0+, and is written using ARC.

Unlike other Markdown libraries, MMMarkdown implements an actual parser. It is not a port of the original Perl implementation and does not use regular expressions to transform the input into HTML. MMMarkdown tries to be efficient and minimize memory usage.

API

Using MMMarkdown is simple. The main API is a single class method:

#import <MMMarkdown/MMMarkdown.h>

NSError  *error;
NSString *markdown   = @"# Example\nWhat a library!";
NSString *htmlString = [MMMarkdown HTMLStringWithMarkdown:markdown error:&error];
// Returns @"<h1>Example</h1>\n<p>What a library!</p>"

The markdown string that is passed in must be non-nil.

MMMarkdown also supports a number of Markdown extensions:

#import <MMMarkdown/MMMarkdown.h>

NSString *markdown   = @"~~Mistaken~~";
NSString *htmlString = [MMMarkdown HTMLStringWithMarkdown:markdown extensions:MMMarkdownExtensionsGitHubFlavored error:NULL];
// Returns @"<p><del>Mistaken</del></p>"

Setup

Adding MMMarkdown to your Mac or iOS project is easy.

0. Add MMMarkdown as a git submodule. (git submodule add https://github.com/mdiep/MMMarkdown <path>)

1. Add MMMarkdown.xcodeproj to your project or workspace

2. Add libMMMarkdown-Mac.a or libMMMarkdown-iOS.a to the "Link Binary with Libraries" section of your project's "Build Phases".

3. Add $(CONFIGURATION_BUILD_DIR)/MMMarkdown-Mac/public/ or $(CONFIGURATION_BUILD_DIR)/MMMarkdown-iOS/public/ to the "Header Search Paths" in your project's "Build Settings".

License

MMMarkdown is available under the MIT License.