Need help with MarkdownView-Android?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

mukeshsolanki
422 Stars 81 Forks MIT License 43 Commits 1 Opened issues

Description

MarkdownView is an Android webview with the capability of loading Markdown text or file and display it as HTML, it extends Android webview.

Services available

!
?

Need anything else?

Contributors list

MarkdownView



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

Demo

Supporting MarkdownView

MarkdownView is an independent project with ongoing development and support made possible thanks to donations made by these awesome backers. If you'd like to join them, please consider:

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

java
dependencies {
    implementation 'com.github.mukeshsolanki:MarkdownView-Android:'
}

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.


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

Java
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

GitHub contributors

License

Copyright (c) 2018 Mukesh Solanki

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.