{"id":14979965,"url":"https://github.com/mukeshsolanki/markdownview-android","last_synced_at":"2025-05-16T04:04:17.394Z","repository":{"id":43232965,"uuid":"64218571","full_name":"mukeshsolanki/MarkdownView-Android","owner":"mukeshsolanki","description":"Markdown lets you easily display markdown data in android and its compose ready.","archived":false,"fork":false,"pushed_at":"2024-02-26T19:12:23.000Z","size":3587,"stargazers_count":618,"open_issues_count":9,"forks_count":94,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-05-16T04:04:15.878Z","etag":null,"topics":["android","android-webview","codeview","compose","composer-library","gradle","jetpack","jetpack-android","jetpack-compose","markdownview","md","readme"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mukeshsolanki.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"patreon":"mukeshsolanki","custom":"https://www.paypal.me/mukeshsolanki"}},"created_at":"2016-07-26T12:13:13.000Z","updated_at":"2025-05-14T11:29:53.000Z","dependencies_parsed_at":"2024-09-28T03:41:12.069Z","dependency_job_id":null,"html_url":"https://github.com/mukeshsolanki/MarkdownView-Android","commit_stats":{"total_commits":44,"total_committers":7,"mean_commits":6.285714285714286,"dds":0.5681818181818181,"last_synced_commit":"173f8d9484aa66569da49ad3c2862ef26b1b6381"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mukeshsolanki%2FMarkdownView-Android","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mukeshsolanki%2FMarkdownView-Android/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mukeshsolanki%2FMarkdownView-Android/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mukeshsolanki%2FMarkdownView-Android/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mukeshsolanki","download_url":"https://codeload.github.com/mukeshsolanki/MarkdownView-Android/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254464891,"owners_count":22075570,"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","android-webview","codeview","compose","composer-library","gradle","jetpack","jetpack-android","jetpack-compose","markdownview","md","readme"],"created_at":"2024-09-24T14:01:01.236Z","updated_at":"2025-05-16T04:04:17.351Z","avatar_url":"https://github.com/mukeshsolanki.png","language":"JavaScript","funding_links":["https://patreon.com/mukeshsolanki","https://www.paypal.me/mukeshsolanki"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eCompose Markdown View\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca class=\"badge-align\" href=\"https://www.codacy.com/app/mukeshsolanki/MarkdownView-Android?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=mukeshsolanki/MarkdownView-Android\u0026amp;utm_campaign=Badge_Grade\"\u003e\u003cimg src=\"https://api.codacy.com/project/badge/Grade/58e51bc418d349499b3eac9c3f6f3ef1\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://jitpack.io/#mukeshsolanki/MarkdownView-Android\"\u003e\u003cimg src=\"https://jitpack.io/v/mukeshsolanki/MarkdownView-Android/month.svg\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://jitpack.io/#mukeshsolanki/MarkdownView-Android/\"\u003e \u003cimg src=\"https://jitpack.io/v/mukeshsolanki/MarkdownView-Android.svg\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/mukeshsolanki/MarkdownView-Android/actions\"\u003e \u003cimg src=\"https://github.com/mukeshsolanki/MarkdownView-Android/workflows/Build/badge.svg\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg\"/\u003e\u003c/a\u003e\n  \u003cbr /\u003e\u003cbr /\u003e\n    MarkdownView is a composable library that helps you display Markdown text or files on Android as a html page just like Github.\n\u003c/p\u003e\n\n![Demo](https://raw.githubusercontent.com/mukeshsolanki/MarkdownView-Android/master/Screenshots/demo.gif)\n\n# Supporting Compose Markdown View\n\nCompose Markdown View is an independent project with ongoing development and support made possible thanks to your donations.\n- [Become a backer](https://www.paypal.me/mukeshsolanki)\n\n## Getting started\nIts really simple to integrate *Markdown* in android. All you need to do make the following change to you build gradle under the app module.\n\nStep 1. Add the JitPack repository to your build file. Add it in your root build.gradle at the end of repositories:\n\n```kotlin\nallprojects {\n  repositories {\n    ...\n    maven { url \"https://jitpack.io\" }\n  }\n}\n```\n\nStep 2. Add the dependency\n```kotlin\ndependencies {\n    implementation 'com.github.mukeshsolanki:MarkdownView-Android:2.0.0'\n}\n```\n\n## How to use Markdown\nIts fairly simple and straight forward to use *Markdown* in you application.\n\n- Using Compose\n\nJust use `MarkDown` composable where you need to display the view like\n```kotlin\nMarkDown(\n    url = URL(\"https://raw.githubusercontent.com/mukeshsolanki/MarkdownView-Android/main/README.md\"),\n    modifier = Modifier.fillMaxSize()\n)\n```\n\n- Using Older View System (aka XML)\n\nAdd a compose view in your xml file like\n```XML\n\u003candroidx.compose.ui.platform.ComposeView\n    android:id=\"@+id/markdown\"\n    android:layout_width=\"match_parent\"\n    android:layout_height=\"match_parent\" /\u003e\n```\n\nand reference it in your activity/fragment and assign the markdown text/file like wise.\n```kotlin\nval markdown = findViewById(R.id.markdown)\nmarkdown.composeView.apply {\n    // Dispose of the Composition when the view's LifecycleOwner is destroyed\n    setViewCompositionStrategy(DisposeOnViewTreeLifecycleDestroyed)\n    setContent {\n       // In Compose world\n       MaterialTheme {\n            MarkDown(\n                url = URL(\"https://raw.githubusercontent.com/mukeshsolanki/MarkdownView-Android/main/README.md\"),\n                modifier = Modifier.fillMaxSize()\n            )\n       }\n    }\n}\n```\n## Markdown Sources\nYou have 3 different sources from where markdown data can be read\n- `Text` - You can pass the content and string to render the markdown\n```kotlin\nMarkDown(\n    text = \"# Test Markdown\",\n    modifier = Modifier.fillMaxSize()\n)\n```\n- `File` - You can read from a file and display the markdown data.\n```kotlin\nMarkDown(\n    file = file,\n    modifier = Modifier.fillMaxSize()\n)\n```\n- `URL` - You can also specify the url of the markdown file.\n```kotlin\nMarkDown(\n    url = URL(\"https://raw.githubusercontent.com/mukeshsolanki/MarkdownView-Android/main/README.md\"),\n    modifier = Modifier.fillMaxSize()\n)\n```\n\n## Author\nMaintained by [Mukesh Solanki](https://www.github.com/mukeshsolanki)\n\n## Contribution\n[![GitHub contributors](https://img.shields.io/github/contributors/mukeshsolanki/MarkdownView-Android.svg)](https://github.com/mukeshsolanki/MarkdownView-Android/graphs/contributors)\n\n* Bug reports and pull requests are welcome.\n\n## License\n```\nCopyright (c) 2018 Mukesh Solanki\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmukeshsolanki%2Fmarkdownview-android","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmukeshsolanki%2Fmarkdownview-android","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmukeshsolanki%2Fmarkdownview-android/lists"}