Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/falnatsheh/markdownview
MarkdownView is an Android webview with the capablity of loading Markdown text or file and display it as HTML, it uses MarkdownJ and extends Android webview.
https://github.com/falnatsheh/markdownview
android css markdown markdownview
Last synced: about 2 months ago
JSON representation
MarkdownView is an Android webview with the capablity of loading Markdown text or file and display it as HTML, it uses MarkdownJ and extends Android webview.
- Host: GitHub
- URL: https://github.com/falnatsheh/markdownview
- Owner: falnatsheh
- License: other
- Archived: true
- Created: 2011-12-25T18:22:40.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2019-03-15T09:22:51.000Z (over 5 years ago)
- Last Synced: 2024-09-25T22:40:53.858Z (about 2 months ago)
- Topics: android, css, markdown, markdownview
- Language: CSS
- Homepage:
- Size: 5.57 MB
- Stars: 1,011
- Watchers: 28
- Forks: 164
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: license.txt
Awesome Lists containing this project
README
[](https://bintray.com/falnatsheh/maven/MarkdownView/_latestVersion)
## About
MarkdownView (Markdown For Android) is an Android library that helps you display Markdown text or files (local/remote) as formatted HTML, and style the output using CSS.
The MarkdownView itself extends Android Webview and adds the necessary logic to parse Markdown (using MarkdownJ) and display the output HTML on the view.
## Getting started
- To add MarkdownView to your project, add the following to `build.gradle` file:
```javascript
dependencies {
compile 'us.feras.mdv:markdownview:1.1.0'
}
```
## Usage
Add MarkdownView to your layout:
```xml
```
and reference it in your Activity/Fragment:
```java
MarkdownView markdownView = (MarkdownView) findViewById(R.id.markdownView);
markdownView.loadMarkdown("## Hello Markdown");
```
**Note**:
You could also create the view by code. Below an example of how to set the whole activity to be a MarkdownView by Adding the following to your onCreate method:
```java
MarkdownView markdownView = new MarkdownView(this);
setContentView(markdownView);
markdownView.loadMarkdown("## Hello Markdown");
```
## Screenshots
## Demo App and Code Sample
The above screenshots taking from the demo app which could be found here. The demo app include code to demonstrate:
- Loading Local Markdown File.
- Loading Remote Markdown File.
- Loading Markdown text.
- Live Preview sample code (similar to [Marked Mac app](http://marked2app.com/))
- Themes
## Loading Markdown text or file:
- `loadMarkdown(String text)`:
Using this method will result in loading md string to the MarkdownView and displaying it as HTML.
- `loadMarkdownFile(String url)`:
You can use this method to load local or online files.
To load a local file, you have to add it to your assets folder and pass a url that start with "file:///android_asset/" :
```java
markdownView.loadMarkdownFile("file:///android_asset/myFile.md");
```
To load a remote file you need to pass the full url :
```java
markdownView.loadMarkdownFile("http://www.my-site.com/myFile.md");
```
## Theming
You could apply custom CSS to the MarkdownView. Example:
```java
markdownView.loadMarkdownFile("file:///android_asset/hello.md","file:///android_asset/MyCustomTheme.css");
```
You could take a look at CSS example [here](https://github.com/falnatsheh/MarkdownView/tree/master/css-themes), you could also view them in the sample app.
## ChangeLog:
- **MarkdownView 1.1.0**:
- Support Loading Markdown file from assets subfolders (Thanks [@echodjb](https://github.com/DiegoRosado)).
- **MarkdownView 1.0.0**:
- Convert to Gradle Project (Avillable now on [jCenter](https://bintray.com/falnatsheh/maven/MarkdownView/view)).
- Fix CSS Issue (Thanks [@swanson](https://github.com/swanson) & [@echodjb](https://github.com/echodjb)).
- Update demo app.
## License
Apache 2.0