- Notifications
You must be signed in to change notification settings - Fork0
Markdown renderer for Kotlin Multiplatform Projects (Android, iOS, Desktop), using Compose.
License
b3er/multiplatform-markdown-renderer
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
... a Kotlin Multiplatform Markdown Renderer. (Android, Desktop, ...) powered by Compose Multiplatform
What's included 🚀 •Setup 🛠️ •Usage 🛠️ •License 📓
- Super simple setup
- Cross-platform ready
- Lightweight
Multiplatform
For multiplatform projects specify this single dependency:
dependencies { implementation("com.mikepenz:multiplatform-markdown-renderer:${version}")// Offers Material 2 defaults for Material 2 themed apps (com.mikepenz.markdown.m2.Markdown) implementation("com.mikepenz:multiplatform-markdown-renderer-m2:${version}")// Offers Material 3 defaults for Material 3 themed apps (com.mikepenz.markdown.m3.Markdown) implementation("com.mikepenz:multiplatform-markdown-renderer-m3:${version}")}JVM
To use the library on JVM, you have to include:
dependencies { implementation("com.mikepenz:multiplatform-markdown-renderer-jvm:${version}")}Android
For Android a special dependency is available:
dependencies { implementation("com.mikepenz:multiplatform-markdown-renderer-android:${version}")}Tip
Since 0.13.0 the core library does not depend on a Material theme anymore. Include the-m2 or-m3 module to getaccess to the defaults.
val markdown="""### What's included 🚀- Super simple setup- Cross-platform ready- Lightweight""".trimIndent()//Markdown(markdown)
Advanced Usage
The library offers the ability to modify different behaviour when rendering the markdown.
Markdown( content, colors= markdownColors(text=Color.Red), typography= markdownTypography(h1=MaterialTheme.typography.body1))
// Use the bullet list symbol from the original markdownCompositionLocalProvider(LocalBulletListHandler provides {"$it" }) {Markdown(content)}// Replace the ordered list symbol with `A.)` instead.CompositionLocalProvider(LocalOrderedListHandler provides {"A.)" }) {Markdown(content,Modifier.fillMaxSize().padding(16.dp).verticalScroll(scrollState))}
Since v0.9.0 it is possible to provide custom components, instead of the default ones.This can be done by providing the componentsMarkdownComponents to theMarkdown composable.
Use themarkdownComponents() to keep defaults for non overwritten components.
TheMarkdownComponent will expose access to thecontent: String,node: ASTNode,typography: MarkdownTypography,offering full flexibility.
// Simple adjusted paragraph with different Modifier.val customParagraphComponent:MarkdownComponent= {MarkdownParagraph(it.content, it.node,Modifier.align(Alignment.End))}// Full custom paragraph exampleval customParagraphComponent:MarkdownComponent= {// build a styled paragraph. (util function provided by the library)val styledText= buildAnnotatedString { pushStyle(LocalMarkdownTypography.current.paragraph.toSpanStyle()) buildMarkdownAnnotatedString(content, it.node) pop() }// define the `Text` composableText( styledText, modifier=Modifier.align(Alignment.End), textAlign=TextAlign.End )}// Define the `Markdown` composable and pass in the custom paragraph componentMarkdown( content, components= markdownComponents( paragraph= customParagraphComponent ))
This project uses JetBrainsmarkdown Multiplatform Markdown processor asdependency to parse the markdown content.
This free, open source software was also made possible by a group of volunteers that put many hours of hard work intoit. See theCONTRIBUTORS.md file for details.
Big thanks toErik Hellman and his awesome articleonRendering Markdown with Jetpack Compose, and therelated sourceMarkdownComposer.
Copyright for portions of the code are held by [Erik Hellman, 2020] as part ofprojectMarkdownComposer under the MIT license. All other copyrightfor project multiplatform-markdown-renderer are held by [Mike Penz, 2023] under the Apache License, Version 2.0.
Copyright 2024 Mike PenzLicensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.About
Markdown renderer for Kotlin Multiplatform Projects (Android, iOS, Desktop), using Compose.
Resources
License
Security policy
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Languages
- Kotlin97.3%
- Ruby2.7%