unnoo / Markdium

objc wrapper for cmark-gfm, support iOS, macOS, tvOS.

Markdium

ObjC wrapper for cmark-gfm, support iOS, macOS, tvOS.

build upon cmark-gfm

with Carthage

github "cntrump/Markdium" "master"

build staticlib

carthage update Markdium

How to use

ObjC

@import Markdium;

Swift

import Markdium

Supported Options

• MDOptionDefault
• MDOptionSourcePos
• MDOptionHardBreaks
• MDOptionSafe
• MDOptionUnsafe
• MDOptionNoBreaks
• MDOptionValidateUTF8
• MDOptionSmart
• MDOptionGithubPreLang
• MDOptionLiberalHTMLTag
• MDOptionFootnotes
• MDOptionStrikethroughDoubleTilde
• MDOptionTablePreferStyleAttributes
• MDOptionFullInfoString

Supported Extensions

• MDExtensionNone
• MDExtensionTagFilter
• MDExtensionAutolink
• MDExtensionStrikethrough
• MDExtensionTasklist
• MDExtensionTable
• MDExtensionAll

NSString *str = @"[Github](https://github.com \"github\")";
Markdium *md = [[Markdium alloc] initWithString:str options:MDOptionDefault extensions:MDExtensionNone];

[md renderAsHTML];

/** output:
<p><a href="https://github.com" title="github">Github</a></p>
**/

[md renderAsXML];

/** output:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document SYSTEM "CommonMark.dtd">
<document xmlns="http://commonmark.org/xml/1.0">
  <paragraph>
    <link destination="https://github.com" title="github">
      <text xml:space="preserve">Github</text>
    </link>
  </paragraph>
</document>
**/

[md renderAsLatex];

/** output:
\href{https://github.com}{Github}
**/

[md renderAsMAN];

/** output:
.PP
Github (https://github.com)
**/

[md renderAsCommonMark];

/** output:
[Github](https://github.com "github")
**/

[md renderAsPlaintext];

/** output:
Github
**/

AST support

MDNode *document = [md parseAsAST];