Giter VIP home page Giter VIP logo

simplemarkdownparser's Introduction

SimpleMarkdownParser

CI Status Version License Platform

A multi-functional and easy way to integrate markdown formatting within mobile apps. Supports iOS and Android.

Features

  • Easy to use, convert markdown to attributed text for UILabels (iOS) or spannable strings for TextViews (Android)
  • Highly customizable, use the core library to search for markdown tags for customized styling
  • Also customizable without using the core library through a simple protocol (iOS) or interface (Android)
  • Parses the following markdown tags: headers (#), text styles (italics and bold), strike through text, lists and links
  • Supports escaping of markdown tag characters (using \)
  • Uses fast native code (optionally) for Android to do the core parsing work

iOS integration guide

The library is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "SimpleMarkdownParser", '~> 0.4.0'

Android integration guide

When using gradle, the library can easily be imported into the build.gradle file of your project. Add the following dependency:

compile ('com.crescentflare.simplemarkdownparser:SimpleMarkdownParserLib:0.4.0') {
transitive = false
}

Make sure that jcenter is added as a repository.

Example

The provided example shows how to parse markdown, convert it to an attributed text or spannable string (or html) and show it on a text view. Also it contains an example on how to apply custom styling easily.

Status

The library is new and doesn't contain all markdown features, but the commonly used features should be supported. Markdown conversion and customization is now complete enough to be used in an easy way. More markdown support and features will be added later.

simplemarkdownparser's People

Watchers

 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.