MarkdownView-Android

Additional

Language
JavaScript
Version
1.0.5 (Nov 7, 2017)
Created
Jul 26, 2016
Updated
Apr 23, 2018
Owner
Mukesh Solanki (mukeshsolanki)
Contributors
Michal Tajchert (tajchert)
Mukesh Solanki (mukeshsolanki)
LittleHans8
3
Activity
Badge
Generate
Download
Source code
APK file

Show card

MarkdownView



MarkdownView is a simple library that helps you display Markdown text or files on Android as a html page just like Github.

Getting started

Its really simple to integrate MarkdownView in android. All you need to do make the following change to you build gradle under the app module.

Step 1. Add the JitPack repository to your build file. Add it in your root build.gradle at the end of repositories:

allprojects {
  repositories {
    ...
    maven { url "https://jitpack.io" }
  }
}

Step 2. Add the dependency

dependencies {
    implementation 'com.github.mukeshsolanki:MarkdownView-Android:<latest-version>'
}

How to use MarkdownView

Its fairly simple and straight forward to use MarkdownView in you application. Just add the following in your layout where you want to display the markdown file/text.

<com.mukesh.MarkdownView
    android:id="@+id/markdown_view"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
/>

and reference it in your activity/fragment and assign the markdown text/file like wise.

MarkdownView markdownView = (MarkdownView) findViewById(R.id.markdown_view);
markdownView.setMarkDownText("# Hello World\nThis is a simple markdown"); //Displays markdown text
...
markdownView.loadMarkdownFromAssets("README.md"); //Loads the markdown file from the assets folder
...
File markdownFile=new File("filePath");
markdownView.loadMarkdownFromFile(markdownFile); //Loads the markdown file.

Author

Maintained by Mukesh Solanki

Contribution

License

Copyright 2018 Mukesh Solanki

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.