-
-
Notifications
You must be signed in to change notification settings - Fork 91
/
params.json
6 lines (6 loc) · 2.84 KB
/
params.json
1
2
3
4
5
6
{
"name": "Markdownview (Android)",
"tagline": "MarkdownView is an Android webview with the capability of loading Markdown text or file and display it as HTML, it extends Android webview.",
"body": "<h1 align=\"center\">MarkdownView</h1>\r\n<p align=\"center\">\r\n <a href=\"https://android-arsenal.com/api?level=14\"> <img src=\"https://img.shields.io/badge/API-14%2B-blue.svg?style=flat\" /></a>\r\n <a href=\"https://jitpack.io/#mukeshsolanki/MarkdownView-Android/\"> <img src=\"https://jitpack.io/v/mukeshsolanki/MarkdownView-Android.svg\" /></a>\r\n <a href=\"http://android-arsenal.com/details/1/3980\"> <img src=\"https://img.shields.io/badge/Android%20Arsenal-MarkdownView--Android-brightgreen.svg?style=flat\" /></a>\r\n <a href=\"https://travis-ci.org/mukeshsolanki/MarkdownView-Android\"> <img src=\"https://travis-ci.org/mukeshsolanki/MarkdownView-Android.svg?branch=master\" /></a>\r\n <a href=\"https://www.paypal.me/mukeshsolanki\"> <img src=\"https://img.shields.io/badge/paypal-donate-yellow.svg\" /></a>\r\n <br /><br /> \r\n MarkdownView is a simple library that helps you display Markdown text or files on Android as a html page just like Github.\r\n</p>\r\n\r\n\r\n![Demo](https://raw.githubusercontent.com/mukeshsolanki/MarkdownView-Android/master/Screenshots/demo.gif)\r\n\r\n## Getting started\r\nIts really simple to integrate *MarkdownView* in android. All you need to do make the following change to you build gradle under the app module.\r\n\r\nStep 1. Add the JitPack repository to your build file. Add it in your root build.gradle at the end of repositories:\r\n\r\n```java\r\nallprojects {\r\n repositories {\r\n ...\r\n maven { url \"https://jitpack.io\" }\r\n }\r\n}\r\n```\r\n\r\nStep 2. Add the dependency\r\n```java\r\ndependencies {\r\n compile 'com.github.mukeshsolanki:MarkdownView-Android:1.0.1'\r\n}\r\n```\r\n\r\n## How to use MarkdownView\r\n\r\nIts 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.\r\n\r\n```XML\r\n<com.mukesh.MarkdownView\r\n android:id=\"@+id/markdown_view\"\r\n android:layout_width=\"match_parent\"\r\n android:layout_height=\"match_parent\"\r\n/>\r\n```\r\n\r\nand reference it in your activity/fragment and assign the markdown text/file like wise.\r\n```Java\r\nMarkdownView markdownView = (MarkdownView) findViewById(R.id.markdown_view);\r\nmarkdownView.setMarkDownText(\"# Hello World\\nThis is a simple markdown\"); //Displays markdown text\r\n...\r\nmarkdownView.loadMarkdownFromAssets(\"README.md\"); //Loads the markdown file from the assets folder\r\n...\r\nFile markdownFile=new File(\"filePath\");\r\nmarkdownView.loadMarkdownFromFile(markdownFile); //Loads the markdown file.\r\n```\r\n",
"note": "Don't delete this file! It's used internally to help with page regeneration."
}