Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
title
Introduction

Markwon Logo



markwon Build

Markwon is a markdown library for Android. It parses markdown following

with the help of amazing library and renders result as _Android-native_ Spannables. **No HTML** is involved as an intermediate step. **No WebView** is required. It's extremely fast, feature-rich and extensible.

It gives ability to display markdown in all TextView widgets (TextView, Button, Switch, CheckBox, etc), Toasts and all other places that accept Spanned content. Library provides reasonable defaults to display style of a markdown content but also gives all the means to tweak the appearance if desired. All markdown features listed in are supported (including support for inlined/block HTML code, markdown tables, images and syntax highlight).

Since version Markwon comes with an editor to highlight markdown input as user types (for example in EditText).

Supported markdown features

  • Emphasis (*, _)
  • Strong emphasis (**, __)
  • Headers (#{1,6})
  • Links ([]() && [][])
  • Images
  • Thematic break (---, ***, ___)
  • Quotes & nested quotes (>{1,})
  • Ordered & non-ordered lists & nested ones
  • Inline code
  • Code blocks
  • Strike-through (~~)
  • Tables (with limitations)
  • Syntax highlight
  • LaTeX formulas
  • HTML
    • Emphasis (<i>, <em>, <cite>, <dfn>)
    • Strong emphasis (<b>, <strong>)
    • SuperScript (<sup>)
    • SubScript (<sub>)
    • Underline (<u>, ins)
    • Strike-through (<s>, <strike>, <del>)
    • Link (a)
    • Lists (ul, ol)
    • Images (img will require configured image loader)
    • Blockquote (blockquote)
    • Heading (h1, h2, h3, h4, h5, h6)
    • there is support to render any HTML/XML tag, but it will require to create a special TagHandler, more information can be found in HTML section
  • Task lists:
  • Not done
  • Done with X
  • and or small x

Screenshots

screenshot light #1

screenshot light #2

screenshot light #3

screenshot dark #2

By default configuration uses TextView textColor for styling, so changing textColor changes style


<style> .awesome-block { background-color: #4CAF50; height: 7rem; display: flex; justify-content: center; align-items: center; } .awesome-block * { border: 0 } </style>

# Awesome Markwon


  • Partico - Partiko is a censorship free social network.
  • FairNote - simple and intuitive notepad app. It gives you speed and efficiency when you write notes, to-do lists, e-mails, or jot down quick ideas.
  • Boxcryptor - A software that adds AES-256 and RSA encryption to Dropbox, Google Drive, OneDrive and many other clouds.
  • Senstone Portable Voice Assistant - Senstone is a tiny wearable personal assistant powered by this App. It lets you capture your ideas, notes and reminders handsfree without pulling out your phone.

Extension/plugins:

  • MarkwonCodeEx - Markwon extension support elegant code background.

Help to improve this section by submitting your application or library that is using Markwon