Code Monkey home page Code Monkey logo

ghmarkdownparser's Introduction

GHMarkdownParser

GHMarkdownParser is a GitHub Flavored Markdown parser for iOS and Mac OS, based on discount.

How to setup GHMarkdownParser in your project

  • add GHMarkdownParser as a submodule to your project

  • navigate into GHMarkdownParser directory and initialize the submodules

    git submodule init
    git submodule update
    
  • drag and drop the GHMarkdownParser.xcodeproj into your project

  • select your project target -> build settings

    • fill Other Linker Flags with -Objc and -all_load
    • add the path of GHMarkdownParser to Library Search Paths and Header Search Paths
  • go into build phases

    • add GHMarkdownParser (for iOS) or GHMarkdownParser Mac (for Mac) to Target Dependencies
    • add libGHMarkdownParser.a (for iOS) or libGHMarkdownParser_Mac.a (for Mac) to Link Binary with Libraries

How to use GHMarkdownParser

  • import the GHMarkdownParser header

    #import "GHMarkdownParser.h"
  • convert any markdown formatted string into HTML

    NSString *markdown = ...;
    NSString *HTML = markdown.flavoredHTMLStringFromMarkdown;
  • Or for greater control:

    GHMarkdownParser *parser = [[GHMarkdownParser alloc] init];
    parser.options = kGHMarkdownAutoLink; // for example
    parser.githubFlavored = YES;
    NSString *html = [parser HTMLStringFromMarkdownString:markdownString];

ghmarkdownparser's People

Contributors

oliverletterer avatar snej avatar

Stargazers

eormskim avatar Hun-i, Song avatar Yoon Joonghyun avatar

Watchers

James Cloos avatar Yoon Joonghyun avatar Gwan-ho Kim avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.