MarkedView Example

Introduction

The MarkedView is the markdown text viewer.

Usage

It is a simple module, which enable you to convert any files into initialized view.

// xml
<com.mittsu.markedview.MarkedView
    android:id="@+id/md_view"
    android:layout_width="match_parent"
    android:layout_height="match_parent"/>

// Java code

import com.mittsu.markedview.MarkedView;

・・・

// call from xml
MarkedView mdView = (MarkedView)findViewById(R.id.md_view);
// call from code
// MarkedView mdView = new MarkedView(this);

// set markdown text pattern. ('contents' object is markdown text)
mdView.setMDText(contents);

// load Markdown file pattern.
// mdView.loadFile(filePath)

/* option */

// code block in scrolling be deactivated.
mdView.setCodeScrollDisable();

Demo

• Load file

Read markdown file from asset folder.

• Live rendering

Preview display on the right side of the input field.

Installation

Add the dependency

dependencies {
    compile 'com.mittsu:markedview:1.0.7@aar'
}

See Also

• MarkedView-for-iOS
  https://github.com/mittsuu/MarkedView-for-iOS

Credits

This used the following open source components.

Marked : Markdown parser written in JavaScript

highlight.js : Syntax highlighting for the Web

License

MarkedView is available under the MIT license. See the LICENSE file for more info.