Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 1.52 KB

README.mdown

File metadata and controls

56 lines (40 loc) · 1.52 KB
Raw

A Markdown NSAttributedString Parser

This is a Markdown => NSAttributedString parser built on top of a flex parser. It takes an NSString and returns an NSAttributedString with markdown tags replaced by CoreText formatting attributes.

Adding it to your Project

  1. Drag all of the files from the src/ directory into your project.
  2. Import NSAttributedStringMarkdownParser.h in your project.
  3. Create an instance of the parser object and pass it the string you wish to parse.
  4. Plug the resulting NSAttributedString into your favorite NSAttributedString label implementation.

NSAttributedString Labels

Nimbus: https://github.com/jverkoey/nimbus TTTAttributedLabel: https://github.com/mattt/TTTAttributedLabel

Supported Features

*italics*
**bold**
***bold italic***
~~strike-through~~

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

Header 1
========

Header 2
--------

> Block Quote
>> Block quote level 2

http://google.com urls
[URLs with description](http://google.com 'and optional tooltip')

Example

NSAttributedStringMarkdownParser* parser = [[NSAttributedStringMarkdownParser alloc] init];
NSAttributedString* string = [parser attributedStringFromMarkdownString:
                              @"This is __rad__.""];

See the Catalog application included with the project for more examples.