An Objective-C framework for converting Markdown to HTML.

Matt Diephouse

Last update: Dec 14, 2022

Related tags

Overview

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.

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 project is easy.

If you’d like to use Carthage, add the following line to your Cartfile:

github "mdiep/MMMarkdown"

Otherwise, you can:

Add MMMarkdown as a git submodule. (git submodule add https://github.com/mdiep/MMMarkdown <path>)
Add MMMarkdown.xcodeproj to your project or workspace
Add MMMarkdown.framework to the ”Link Binary with Libraries" section of your project's “Build Phases”.
Add MMMarkdown.framework to a ”Copy Files” build phase that copies it to the Frameworks destination.

License

MMMarkdown is available under the MIT License.

Comments

Cocoapods Support

It would be great if there was a public podspec available in order to include the library in a project.

I lean towards avoiding git submodules.

Many thanks in advance

opened by a1cooke 11
GitHub Flavored Markdown
Add support for GitHub Flavored Markdown.

[x] Autolinked URLs

[x] Fenced code blocks

[x] Hard newlines

[x] Strikethroughs

[x] Tables

[x] Underscores in words

[x] Inline word boundaries

[x] Update README
opened by mdiep 11
Added Cocoapods podspec
Added from Specs-master/Specs/MMMarkdown/0.3/MMMarkdown.podspec.json.

This allows those of us using cocoapods to manage dependencies to pull in the latest master commit of MMMarkdown. In order to to do that, the pod spec needs to be in the root of the repo as per http://guides.cocoapods.org/using/the-podfile.html#from-a-podspec-in-the-root-of-a-library-repo

All I did was copy the existing pod spec from the Cocoapods master spec repo and put it in the root of the MMMarkdown repo. This allows me to use MMMarkdown in my project in one of two ways:

# Use the latest GM release from cocoapods (currently version 0.3) pod 'MMMarkdown' # or use the latest commit to master pod 'MMMarkdown', :git => 'https://github.com/mdiep/MMMarkdown.git'

I have tested both after the change and they both work so this is a low-risk merge.

Thanks for MMMarkdown - I'm really enjoying using it! :-)
opened by iosdev-republicofapps 9
Performance on iOS 8

It's taking to me rendering a simple markdown like 5 seconds on iOS 8. I've not tested it yet on previous iOS versions, but I guess this a performance leak on iOS 8, maybe NSAttributedString is kinda tricky now.

I mean, not rendering it, but generating the NSAttributedString from the HTML. The conversion from raw Markdown to HTML is working fine, is quick. But when you have to get the NSAttributedString, oh boy, it takes like forever.

Could you please look into it?

Regards.

opened by AlvaroFranco 9
Not converting markdown to html for Table
Hello, I am using XCode 7.0 & using this library. I am trying to convert markdown to HTML string for Table. I am passing markdown tag for table as per the following.

| Tables | Are | Cool | | --- | :-: | --: | | col 3 is | right-aligned | $1600 | | col 2 is | centered | $12 | | zebra stripes | are neat | $1 |

But, Its not giving me proper HTML Output as per the following

<table><thead><tr></tr></thead><tbody><tr></tr></tbody></table><p>|Tables|Are|Cool|<br /> | ------------- | : ------------- : | ----- : |<br /> | col 3 is | right-aligned | $1600 |<br /> | col 2 is | centered | $12 |</p>
opened by hardikpithadia 8

Lack of support for image links

The following markdown should produce an image link:

[![Werewolf Cop](http://ecx.images-amazon.com/images/I/51UENmW1sgL._SL175_.jpg)](http://www.amazon.com/exec/obidos/ASIN/1605986984/ref=nosim/founders-20)

Like so:

Instead, it produces the following:

bug

opened by albertbori 8

not support objective-c block
@mdiep this framework doesn't support objective-c block. For example, I try to parse the following block with MMMarkdown, however it doesn't work.

@interface ViewController () @property (nonatomic, weak) IBOutlet UITextView *blockTextView; @end

Could you please add this feature? GitHub support that. Thanks
opened by xuguojun 6
Line breaks weird behavior.

Input: Lorem ipsum.\n \n Lorem ipsum. Output: <"p>Lorem ipsum.<"/p> <"p>Lorem ipsum.<"/p>

Input: Lorem ipsum.\n \n \n Lorem ipsum. Output: <"p>Lorem ipsum.<"/p> <"p>Lorem ipsum.<"/p>

So regardless of how much line breaks are entered, output is markdown without empty line.

P.S There're no quotes inside paragraph tags in output, I've put them there to prevent github markdown parsing.

opened by njuri 6
MMMarkdownExtensionsUnderscoresInWords should allow asterisks within words to still bold, italicize and bold italicize
MMMarkdown diverges a bit from GFM with respect to underscores vs asterisks in words.

In GFM, e.g. what I'm using to edit this issue notice that underscores are not italicized or bolded within a word:

Hello__world__today is not bolded. // produces:

Hello__world__today is not bolded.

Whereas GFM does italicize or bold with asterisks within a word:

Hello**world**today is bolded. // produces:

Helloworldtoday is bolded.

In the GitHub Flavored Markdown Reference they mention that underscores within words are not used for emphasis but that intra-word emphasis can still be achieved using asterisks.

However, the MMMarkdown option MMMarkdownExtensionsUnderscoresInWords turns off both underscores and asterisks within words, whereas based on the name of the option and for consistency with GFM it seems like it should only turn off underscores and not asterisks within words.

This impacts MMSpanParser._parseEmAndStrongWithScanner in a few places.

I like the fact that underscores don't italicize/bold within words: that makes sense for variable names in text. But it would be nice if asterisks still worked. :-)

Thoughts? :-)

Thanks!
bug
opened by iosdev-republicofapps 6
libMMMarkdown-iOS.a is showing red in Xcode

Hi, When I add libMMMarkdown-iOS.a in include libraries in my project ---> It appears as red. it means there is not library like this. Please help me how to include "libMMMarkdown-iOS.a" library in my project.

In your MMMarkdown github folder also I am unable to find "libMMMarkdown-iOS.a" library. Please help me!!

opened by amitch001 5
Add test for mathjax markup

Some Markdown parsers I've found incorrectly convert _ to <em> and various other things. MMMarkdown doesn't (great!) but I thought it would be worth having a test to keep it this way

http://www.mathjax.org/

opened by techiaith 5
How to change font size?

NSString *htmlString = [MMMarkdown HTMLStringWithMarkdown:article.text extensions:MMMarkdownExtensionsGitHubFlavored error:nil];

The font size is too small. I want to make it larger by 5 points.

opened by NikKovIos 0
Request ability to disable html pass through

I would like to ensure that the resulting output is strict and safe, and so would like to have an option which just eats all html (whether inline or block) in the source without passing it through to the result.

opened by jpgoldberg 0
Confirm: versions of OSes

Hi,

I just pushed version 0.5.5 of the podspec. While I was doing that I noticed that the README says:

It is compatible with OS X 10.6+, iOS 8.0+, tvOS, and watchOS.

Would it make sense to add the versions for tvOS and watchOS as in:

It is compatible with OS X 10.6+, iOS 8.0+, tvOS 9.0+, and watchOS 2.0+.

Just a thought.

Cheers!

opened by iosdev-republicofapps 1

Releases(0.5.5)

0.5.5(Jun 27, 2016)
#107: Create NSRegularExpressions using dispatch_once

Source code(tar.gz)
Source code(zip)
MMMarkdown.framework.zip(1.75 MB)
0.5.4(May 4, 2016)
#103: Don't let lists contain both bulleted and numbered items

#104: Require a space after the # in headers

#105: Let list items indent with 2 spaces

Source code(tar.gz)
Source code(zip)
MMMarkdown.framework.zip(4.31 MB)
0.5.3(Apr 19, 2016)
#101: Fix infinite loop in list parsing

Source code(tar.gz)
Source code(zip)
MMMarkdown.framework.zip(4.30 MB)
0.5.2(Dec 29, 2015)
#92: Allow -s in inline HTML

Source code(tar.gz)
Source code(zip)
MMMarkdown.framework.zip(4.00 MB)
0.5.1(Nov 30, 2015)
#88: Update Xcode project settings

#89: Fix some broken unit tests

#90: Add tvOS and watchOS targets

Source code(tar.gz)
Source code(zip)
MMMarkdown.framework.zip(4.03 MB)
0.5(Aug 13, 2015)
#63: Fix warnings from Xcode 6.3

#67: Improved link handling

#71: Allow = in autolinked URLs

#73: Allow dashes in language names

#74: Switch to from static libraries to dynamic frameworks

Source code(tar.gz)
Source code(zip)
MMMarkdown.framework.zip(522.26 KB)
0.4.3(Apr 16, 2015)

#60: UnderscoresInWords should only affect underscores
Source code(tar.gz)
Source code(zip)
0.4.2(Apr 7, 2015)
#51: Fenced code blocks shouldn't allow non-whitespace characters after trailing delimiter

#54: Improve handling of of language names in fenced code blocks

#57: Fix handling of images inside links

Source code(tar.gz)
Source code(zip)
0.4.1(Jan 16, 2015)

Fix an exception when whitespace preceded what would otherwise be a header (#47).
Source code(tar.gz)
Source code(zip)
0.4(Jan 2, 2015)

This release adds support for GitHub-flavored Markdown and extensions. It also includes bug fixes, updated Xcode project settings, and more modernization.
Source code(tar.gz)
Source code(zip)
0.3(Feb 22, 2014)
This release adds an HTML parser, which is needed to properly handle HTML inside Markdown. It also removes the precompiled libraries in favor of including the project.

Other changes include:

Support newer iOS architectures

Fix a crash when passed an empty string

Fix code spans with multiple backticks

Fix code spans that contain newlines

Fix handling of images with no alt text

Annotate that the markdown can't be nil

Fix behavior of archive builds

Update Xcode project settings

Modernize the code

Source code(tar.gz)
Source code(zip)
0.2.3(Jul 2, 2013)

Fix the iOS deployment target and static library to support iOS 5.0.
Source code(tar.gz)
Source code(zip)
0.2.2(Jul 2, 2013)

Updated the iOS static library to include armv7s architecture.
Source code(tar.gz)
Source code(zip)
0.2.1(Jul 2, 2013)
Bugfix release that fixes 2 issues:

Add support for alternate ASCII line endings (\r\n and \r)

Fix a crash when list items have leading spaces beyond their indentation level

Source code(tar.gz)
Source code(zip)
0.2(Jul 2, 2013)

This release focused on expanding the test suite and fixing bugs. Many bugs were fixed and support for the Markdown image syntax was added.
Source code(tar.gz)
Source code(zip)
0.1(Jul 2, 2013)

The initial release of MMMarkdown. Implemented enough of markdown to pass all of Gruber's tests.
Source code(tar.gz)
Source code(zip)