Skip to content
 
 

Repository files navigation

MarkdownView

MarkdownView provides a simple method of displaying Markdown in Android applications, with support for:

  • Markdown flavours (Basic, Extended, Github)
  • Custom markdown blocks, tokens and decorators
  • Themes

This is a fork of the original MarkdownView project, but uses markdown-java for parsing.

Download

Gradle

repositories {
    maven { url "http://dl.bintray.com/fuzeman/maven" }
}

dependencies { 
    compile 'net.dgardiner.mdv:markdownview:1.1.0'
}

Usage

Add MarkdownView to your layout:

<net.dgardiner.mdv.MarkdownView
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:id="@+id/mdv" />

and reference it in your Activity/Fragment:

MarkdownView mdv = (MarkdownView) findViewById(R.id.mdv);
mdv.loadMarkdown("## Hello Markdown"); 

Themes

Themes can be used with:

mdv.loadMarkdown(<markdown>, "file:///android_asset/MyCustomTheme.css");

Themes bundled with the library can be found here.

API

MarkdownView

loadMarkdown

loadMarkdown(String markdown)
loadMarkdown(String markdown, String themeUrl)

Loads the given markdown.

loadMarkdownAsset

loadMarkdownAsset(String assetUri)
loadMarkdownAsset(String assetUri, String themeUrl)

Loads the given markdown asset.

Application assets can be referenced with:

file:///android_asset/[filename]

loadMarkdownUrl

loadMarkdownUrl(String url)
loadMarkdownUrl(String url, String themeUrl)

Loads the given markdown URL.

setPageStartedListener

setPageStartedListener(OnPageStartedListener listener)

setPageFetchedListener

setPageFetchedListener(OnPageFetchedListener listener)

setPageParsedListener

setPageParsedListener(OnPageParsedListener listener)

setPageLoadingListener

setPageLoadingListener(OnPageLoadingListener listener)

setPageFinishedListener

setPageFinishedListener(OnPageFinishedListener listener)

About

MarkdownView provides a simple method for displaying Markdown in Android applications

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages