Skip to content

inquisitiveSoft/SYMLMarkdownParser

Repository files navigation

Why another Markdown Parser?

I wanted a parser which could parse a documents semantics as well as apply styling, and was efficient enough to be updated as the user types. It's simple, efficient, thread safe and compatible with both iOS and Mac.

Get in touch via Twitter @inquisitivesoft if you have any comments or queries. I'm open to issues or pull requests and would love to hear if you end up using SYMLMarkdownParser in one of your projects.

Screenshot of the Example App

Where to Start

  • The core processing is all done in SYMLMarkdownParser.h's SYMLParseMarkdown() function
  • SYMLMarkdownTextFormatter's -parseString:… method is a good place to look for example usage

What it doesn't do

  • It doesn't convert markdown to HTML. There are many more feature complete parsers for that: MultiMarkdown-4 is my current favourite.
  • Currently doesn't highlight code, image tags or inline emphasis elements
  • Needs tests

Requirements

  • Requires RegexKitLite which links against the system libicucore.dylib library
  • Tested on iOS 7 and OS X 10.9, but should be compatible back to iOS 4.0 and OS X 10.6

License

Released under the MIT license, http://opensource.org/licenses/mit-license.php.

About

A lightweight markdown compatible parser written in Objective-C

Resources

License

Stars

Watchers

Forks

Packages

No packages published