Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mdiep/MMMarkdown

An Objective-C framework for converting Markdown to HTML.
https://github.com/mdiep/MMMarkdown

ios markdown objective-c

Last synced: about 2 months ago
JSON representation

An Objective-C framework for converting Markdown to HTML.

Lists

README 

        
# MMMarkdown

MMMarkdown is an Objective-C framework for converting [Markdown][] to HTML. It is compatible with OS X 10.7+, iOS 8.0+, tvOS, and watchOS.



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.



[Markdown]: http://daringfireball.net/projects/markdown/



## API

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



    #import 

    

    NSError  *error;

    NSString *markdown   = @"# Example\nWhat a library!";

    NSString *htmlString = [MMMarkdown HTMLStringWithMarkdown:markdown error:&error];

    // Returns @"
Example
\n
What a library!
"



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



MMMarkdown also supports a number of Markdown extensions:



    #import 

    

    NSString *markdown   = @"~~Mistaken~~";

    NSString *htmlString = [MMMarkdown HTMLStringWithMarkdown:markdown extensions:MMMarkdownExtensionsGitHubFlavored error:NULL];

    // Returns @"
Mistaken
"



## Setup

Adding MMMarkdown to your project is easy.



If you’d like to use [Carthage](https://github.com/Carthage/Carthage), add the following line to your `Cartfile`:



```

github "mdiep/MMMarkdown"

```



Otherwise, you can:



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



0. Add `MMMarkdown.xcodeproj` to your project or workspace



0. Add `MMMarkdown.framework` to the ”Link Binary with Libraries" section of your project's “Build Phases”.



0. Add `MMMarkdown.framework` to a ”Copy Files” build phase that copies it to the `Frameworks` destination.



## License

MMMarkdown is available under the [MIT License][].



[MIT License]: http://opensource.org/licenses/mit-license.php