• This repository has been archived on 18/Jan/2022
  • Stars
    star
    325
  • Rank 129,350 (Top 3 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 8 years ago
  • Updated about 6 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The MarkedView is the markdown text viewer.

MarkedView Example

Android Arsenal License Platform Download

sample_sc

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.

sample_lr

Installation

Add the dependency

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

See Also

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.