Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeziellago/compose-markdown
Markdown Text for Android Jetpack Compose 📋.
https://github.com/jeziellago/compose-markdown
android jetpack-compose kotlin markdown
Last synced: 3 days ago
JSON representation
Markdown Text for Android Jetpack Compose 📋.
- Host: GitHub
- URL: https://github.com/jeziellago/compose-markdown
- Owner: jeziellago
- License: mit
- Created: 2021-03-04T13:40:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T18:12:40.000Z (15 days ago)
- Last Synced: 2024-11-06T12:18:23.726Z (10 days ago)
- Topics: android, jetpack-compose, kotlin, markdown
- Language: Kotlin
- Homepage:
- Size: 15.6 MB
- Stars: 581
- Watchers: 8
- Forks: 49
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - jeziellago/compose-markdown - Markdown Text for Android Jetpack Compose 📋. (Kotlin)
- jetpack-compose-awesome - compose-markdown - Markdown Text for Android Jetpack Compose (Libraries / Testings)
README
# MarkdownText - Jetpack Compose
[](https://androidweekly.net/issues/issue-456)
[](https://github.com/jeziellago/compose-markdown/actions/workflows/ci.yml) [](https://jitpack.io/#jeziellago/compose-markdown)
[![Video]()](https://github.com/jeziellago/compose-markdown/assets/8452419/0e17e3d9-4eb1-44cb-8b63-5056fe74395e)
- Markdown
- HTML
- Image
- Highlight
- Linkfy
- Table
## Setup
1. Open the file `settings.gradle` (it looks like that)
```groovy
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
// add jitpack here 👇🏽
maven { url 'https://jitpack.io' }
...
}
}
...
```
2. Sync the project
3. Add `compose-markdown` dependency
```groovy
dependencies {
implementation 'com.github.jeziellago:compose-markdown:{LAST-RELEASE}'
}
```
# Supported attributes
Most of the attributes of that a default `Text` composable has are also supported by `MarkdownText`.
The font can be changed by passing a font xml resource as `fontResource` parameter.
## How to use
```kotlin
val markdownContent = """
# Sample
* Markdown
* [Link](https://example.com)
Google
"""
//Minimal example
@Composable
fun MinimalExampleContent() {
MarkdownText(markdown = markdownContent)
}
//Complex example
@Composable
fun ComplexExampleContent() {
MarkdownText(
modifier = Modifier.padding(8.dp),
markdown = markdown,
maxLines = 3,
fontResource = R.font.montserrat_medium,
style = TextStyle(
color = Color.Blue,
fontSize = 12.sp,
lineHeight = 10.sp,
textAlign = TextAlign.Justify,
),
)
}
```
### Contributors
Thank you all for your contribution! ❤️
# License
```
Copyright (c) 2021 Jeziel Lago
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.
```