{"id":15108823,"url":"https://github.com/falnatsheh/markdownview","last_synced_at":"2025-09-27T10:30:28.728Z","repository":{"id":2107185,"uuid":"3048733","full_name":"falnatsheh/MarkdownView","owner":"falnatsheh","description":"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.","archived":true,"fork":false,"pushed_at":"2019-03-15T09:22:51.000Z","size":5839,"stargazers_count":1011,"open_issues_count":12,"forks_count":164,"subscribers_count":28,"default_branch":"master","last_synced_at":"2024-09-25T22:40:53.858Z","etag":null,"topics":["android","css","markdown","markdownview"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/falnatsheh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-12-25T18:22:40.000Z","updated_at":"2024-08-27T16:15:06.000Z","dependencies_parsed_at":"2022-09-12T15:30:42.649Z","dependency_job_id":null,"html_url":"https://github.com/falnatsheh/MarkdownView","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falnatsheh%2FMarkdownView","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falnatsheh%2FMarkdownView/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falnatsheh%2FMarkdownView/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falnatsheh%2FMarkdownView/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/falnatsheh","download_url":"https://codeload.github.com/falnatsheh/MarkdownView/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219871971,"owners_count":16554475,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","css","markdown","markdownview"],"created_at":"2024-09-25T22:40:59.224Z","updated_at":"2025-09-27T10:30:23.440Z","avatar_url":"https://github.com/falnatsheh.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n![MarkdownView screenshot](http://i.imgur.com/PufzgYX.jpg)\n[![Download](https://api.bintray.com/packages/falnatsheh/maven/MarkdownView/images/download.svg)](https://bintray.com/falnatsheh/maven/MarkdownView/_latestVersion)\n\n## About\n\nMarkdownView (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.\n\nThe MarkdownView itself extends Android Webview and adds the necessary logic to parse Markdown (using MarkdownJ) and display the output HTML on the view.\n\n## Getting started\n\n- To add MarkdownView to your project, add the following to `build.gradle` file:\n```javascript\n\tdependencies { \n\t    compile 'us.feras.mdv:markdownview:1.1.0'\n\t}\n```\n\n## Usage\n\nAdd MarkdownView to your layout: \n\n```xml\n    \u003cus.feras.mdv.MarkdownView\n        android:layout_width=\"match_parent\"\n        android:layout_height=\"match_parent\"\n        android:id=\"@+id/markdownView\" /\u003e\n```\n\nand reference it in your Activity/Fragment:  \n\n```java\nMarkdownView markdownView = (MarkdownView) findViewById(R.id.markdownView);\nmarkdownView.loadMarkdown(\"## Hello Markdown\"); \n```\n**Note**:\nYou 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:\n\n```java\n  MarkdownView markdownView = new MarkdownView(this);\n  setContentView(markdownView);\n  markdownView.loadMarkdown(\"## Hello Markdown\"); \n```\n\n## Screenshots\n\n\u003cimg src=\"http://i.imgur.com/gY8eXaj.jpg\" width=\"300\"\u003e \n\u003cimg src=\"http://i.imgur.com/ETHYbCv.jpg\" width=\"300\"\u003e \n\n## Demo App and Code Sample\n\nThe above screenshots taking from the demo app which could be found here. The demo app include code to demonstrate: \n\n- Loading Local Markdown File. \n- Loading Remote Markdown File. \n- Loading Markdown text.\n- Live Preview sample code (similar to [Marked Mac app](http://marked2app.com/))\n- Themes\n\n## Loading Markdown text or file: \n\n- `loadMarkdown(String text)`:\nUsing this method will result in loading md string to the MarkdownView and displaying it as HTML. \n\n \n- `loadMarkdownFile(String url)`:\nYou can use this method to load local or online files. \n\nTo load a local file, you have to add it to your assets folder and pass a url that start with \"file:///android_asset/\" : \n\n```java\nmarkdownView.loadMarkdownFile(\"file:///android_asset/myFile.md\");\n```\n\nTo load a remote file you need to pass the full url :    \n\n```java\nmarkdownView.loadMarkdownFile(\"http://www.my-site.com/myFile.md\");\n```\n\n## Theming\n\nYou could apply custom CSS to the MarkdownView. Example: \n\n```java\nmarkdownView.loadMarkdownFile(\"file:///android_asset/hello.md\",\"file:///android_asset/MyCustomTheme.css\");\n```\nYou 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.\n\n## ChangeLog: \n\n- **MarkdownView 1.1.0**:\n\t- Support Loading Markdown file from assets subfolders (Thanks [@echodjb](https://github.com/DiegoRosado)). \n- **MarkdownView 1.0.0**:\n\t- Convert to Gradle Project (Avillable now on [jCenter](https://bintray.com/falnatsheh/maven/MarkdownView/view)). \n\t- Fix CSS Issue (Thanks [@swanson](https://github.com/swanson) \u0026 [@echodjb](https://github.com/echodjb)). \n\t- Update demo app.  \n\n\t\t\t\t\t\t\n## License\nApache 2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffalnatsheh%2Fmarkdownview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffalnatsheh%2Fmarkdownview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffalnatsheh%2Fmarkdownview/lists"}