2017-05-27 16:09:08 +03:00
2017-05-27 14:32:34 +03:00
2017-05-27 14:32:34 +03:00
2017-05-18 16:48:59 +03:00
2017-05-27 15:51:41 +03:00
2017-05-26 12:42:49 +03:00
2017-05-26 12:17:52 +03:00
2017-05-27 15:51:41 +03:00

logo

Markwon

maven|markwon maven|markwon-image-loader maven|markwon-view

Android library for rendering markdown as system-native Spannables. Based on commonmark-java

Installation

compile 'ru.noties:markwon:1.0.0'
compile 'ru.noties:markwon-image-loader:1.0.0' // optional
compile 'ru.noties:markwon-view:1.0.0' // optional

Please note, that this file is created for demonstration purposes. Please refer to library module README instead


Demonstration of default styles (the only thing customized is image loader):

light dark


Supported markdown features:

  • Emphasis (*, _)
  • Strong emphasis (**, __)
  • Strike-through (~~)
  • Headers (#{1,6})
  • Links ([]() && [][])
  • Images (requires special handling)
  • Thematic break (---, ***, ___)
  • Quotes & nested quotes (>{1,})
  • Ordered & non-ordered lists & nested ones
  • Inline code
  • Code blocks
  • Tables (with limitations)
  • Small subset of inline-html (which is rendered by this library):
    • Emphasis (<i>, <em>, <cite>, <dfn>)
    • Strong emphasis (<b>, <strong>)
    • SuperScript (<sup>)
    • SubScript (<sub>)
    • Underline (<u>)
    • Strike-through (<s>, <strike>, <del>)
    • other inline html is rendered via (Html.fromHtml(...))

Emphasis

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet


Strong emphasis

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet


Strike-through

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet


Header 1

Header 2

Header 3

Header 4

Header 5
Header 6

click me

click me

click me

click me


Thematic break




Quotes

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet


Ordered lists

  1. Lorem ipsum dolor sit amet
  2. Lorem ipsum dolor sit amet
    1. Lorem ipsum dolor sit amet
      1. Lorem ipsum dolor sit amet
    2. Lorem ipsum dolor sit amet
  3. Lorem ipsum dolor sit amet

Non-ordered lists

  • Lorem ipsum dolor sit amet
    • Lorem ipsum dolor sit amet
      • Lorem ipsum dolor sit amet
        • Lorem ipsum dolor sit amet
    • Lorem ipsum dolor sit amet
  • Lorem ipsum dolor sit amet

Inline code

Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet


Code block

Lorem ipsum dolor sit amet
Lorem ipsum dolor sit amet
Lorem ipsum dolor sit amet

H.T.M.L.

OKA424342Y


Tables

Header #1 Header #2 Header #3
content content content
long long long skjfs fgjsdfhj sf dfk df sdsd,fklsdfklsdfklsdfkl sdfkl dsfjksdf sjkf jksdfjksdf sjkdf sdfkjsdjkf sdkjfs fkjsf sdkjfs fkjsd fkjsdf skjdf sdkjf skjfs fkjs fkjsdf jskdf sdjkf sjdkf sdkjf skjf sdkjf sdkjf sdfkjsd fkjsd fkjsdf sdkjfsjk dfkjsdf sdkjfs yeah
head #1 head #2
content content
content content
content content
content content
Description
Android markdown library (no WebView)
Readme Apache-2.0
Languages
Java 91.9%
Kotlin 8.1%