Merge pull request #46 from mikepenz/develop

dev -> main

Author: mikepenz

.github/workflows/ci.yml

@@ -20,18 +20,18 @@ jobs:
 
     steps:
       - name: Checkout the repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
-      - uses: actions/setup-java@v2
+      - uses: actions/setup-java@v3
         with:
-          distribution: 'adopt'
-          java-version: '15'
+          distribution: 'temurin'
+          java-version: '17'
 
       - name: Copy CI gradle.properties
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
 
       - name: Checkout Gradle Build Cache
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ~/.gradle/caches
@@ -74,14 +74,14 @@ jobs:
     runs-on: macos-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 100
 
-      - uses: actions/setup-java@v2
+      - uses: actions/setup-java@v3
         with:
-          distribution: 'adopt'
-          java-version: '15'
+          distribution: 'temurin'
+          java-version: '17'
 
       - name: Validate gradle wrapper
         uses: gradle/wrapper-validation-action@v1
@@ -90,7 +90,7 @@ jobs:
         run: mkdir -p ~/.gradle ; cp .github/ci-gradle.properties ~/.gradle/gradle.properties
 
       - name: Checkout Gradle Build Cache
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: |
             ~/.gradle/caches
@@ -149,14 +149,14 @@ jobs:
           find . -name "*release.aab" -type f -exec cp {} "artifacts" \;
 
       - name: Archive Artifacts
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: "App-Artifacts"
           path: artifacts/*
 
       - name: Build Changelog
         id: github_release
-        uses: mikepenz/release-changelog-builder-action@v2
+        uses: mikepenz/release-changelog-builder-action@v3
         if: startsWith(github.ref, 'refs/tags/')
         with:
           configuration: ".github/config/configuration.json"

README.md

@@ -92,6 +92,38 @@ val markdown = """
 Markdown(markdown)
 ```
 
+<details><summary><b>Advanced Usage</b></summary>
+<p>
+
+The library offers the ability to modify different behaviour when rendering the markdown.
+
+### Provided custom style
+
+```kotlin
+Markdown(
+    content,
+    colors = MarkdownDefaults.markdownColors(textColor = Color.Red),
+    typography = MarkdownDefaults.markdownTypography(h1 = MaterialTheme.typography.body1)
+)
+```
+
+### Adjust List Ordering
+
+```kotlin
+// Use the bullet list symbol from the original markdown
+CompositionLocalProvider(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))
+}
+```
+
+</p>
+</details>
+
 ## Dependency
 
 This project uses JetBrains [markdown](https://github.com/JetBrains/markdown/) Multiplatform Markdown processor as dependency to parse the markdown content.

build.gradle.kts

@@ -13,8 +13,8 @@ buildscript {
         classpath("com.vanniktech:gradle-maven-publish-plugin:0.18.0")
         classpath("io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.19.0")
         classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.6.10")
-        classpath("org.jetbrains.dokka:dokka-gradle-plugin:1.6.10")
-        classpath("com.mikepenz.aboutlibraries.plugin:aboutlibraries-plugin:10.1.0")
+        classpath("org.jetbrains.dokka:dokka-gradle-plugin:1.6.21")
+        classpath("com.mikepenz.aboutlibraries.plugin:aboutlibraries-plugin:10.2.0")
         classpath("org.jetbrains.compose:compose-gradle-plugin:1.1.1")
     }
 }

buildSrc/src/main/java/Dependencies.kt

@@ -7,11 +7,11 @@ object Versions {
 
     const val markdown = "0.3.1"
 
-    const val coil = "2.0.0"
+    const val coil = "2.1.0"
     const val compose = "1.1.1"
     const val composeCompiler = "1.1.1"
 
-    const val material = "1.5.0"
+    const val material = "1.6.0"
     const val activityCompose = "1.4.0"
     const val lifecycleKtx = "2.3.1"
 }

gradle.properties

@@ -1,7 +1,7 @@
 # Maven stuff
 GROUP=com.mikepenz
-VERSION_NAME=0.5.0
-VERSION_CODE=500
+VERSION_NAME=0.6.0
+VERSION_CODE=600
 
 POM_URL=https://github.com/mikepenz/multiplatform-markdown-renderer
 
@@ -14,7 +14,7 @@ POM_GITHUB_REPO=mikepenz/multiplatform-markdown-renderer
 POM_GITHUB_README=README.md
 
 POM_LICENCE_NAME=Apache-2.0
-POM_LICENCE_URL=http://www.apache.org/licenses/LICENSE-2.0.txt
+POM_LICENCE_URL=https://www.apache.org/licenses/LICENSE-2.0.txt
 POM_LICENCE_DIST=repo
 
 SONATYPE_HOST=S01

multiplatform-markdown-renderer/src/commonMain/kotlin/com/mikepenz/markdown/Markdown.kt

@@ -352,9 +352,10 @@ private fun MarkdownBulletList(
     style: TextStyle = LocalTextStyle.current,
     level: Int = 0
 ) {
+    val bulletHandler = LocalBulletListHandler.current
     MarkdownListItems(content, node, modifier, colors, style, level) { child ->
         Row(Modifier.fillMaxWidth()) {
-            Text("${child.findChildOfType(MarkdownTokenTypes.LIST_BULLET)?.getTextInNode(content)} ")
+            Text(bulletHandler.transform(child.findChildOfType(MarkdownTokenTypes.LIST_BULLET)?.getTextInNode(content)), style = style, color = colors.textColorByType(MarkdownTokenTypes.LIST_BULLET))
             val text = buildAnnotatedString {
                 pushStyle(style.toSpanStyle())
                 buildMarkdownAnnotatedString(content, child.children.filterNonListTypes(), colors)
@@ -374,9 +375,10 @@ private fun MarkdownOrderedList(
     style: TextStyle = LocalTextStyle.current,
     level: Int = 0,
 ) {
+    val orderedListHandler = LocalOrderedListHandler.current
     MarkdownListItems(content, node, modifier, colors, style, level) { child ->
         Row(Modifier.fillMaxWidth()) {
-            Text("${child.findChildOfType(MarkdownTokenTypes.LIST_NUMBER)?.getTextInNode(content)} ")
+            Text(orderedListHandler.transform(child.findChildOfType(MarkdownTokenTypes.LIST_NUMBER)?.getTextInNode(content)), style = style, color = colors.textColorByType(MarkdownTokenTypes.LIST_NUMBER))
             val text = buildAnnotatedString {
                 pushStyle(style.toSpanStyle())
                 buildMarkdownAnnotatedString(content, child.children.filterNonListTypes(), colors)

multiplatform-markdown-renderer/src/commonMain/kotlin/com/mikepenz/markdown/MarkdownCompositionLocals.kt

@@ -0,0 +1,24 @@
+package com.mikepenz.markdown
+
+import androidx.compose.runtime.staticCompositionLocalOf
+
+/**
+ * The CompositionLocal to provide functionality related to transforming the bullet of an ordered list
+ */
+val LocalBulletListHandler = staticCompositionLocalOf {
+    return@staticCompositionLocalOf BulletHandler { "• " }
+}
+
+/**
+ * The CompositionLocal to provide functionality related to transforming the bullet of an ordered list
+ */
+val LocalOrderedListHandler = staticCompositionLocalOf {
+    return@staticCompositionLocalOf BulletHandler { "$it " }
+}
+
+
+/** An interface of providing use case specific un/ordered list handling.*/
+fun interface BulletHandler {
+    /** Transforms the bullet icon */
+    fun transform(bullet: CharSequence?): String
+}

multiplatform-markdown-renderer/src/commonMain/kotlin/com/mikepenz/markdown/MarkdownDefaults.kt

@@ -80,7 +80,6 @@ private class DefaultMarkdownColors(
     }
 }
 
-
 /**
  * Represents the type scale for the [Markdown].
  *
@@ -98,7 +97,6 @@ interface MarkdownTypography {
     val body2: TextStyle
 }
 
-
 @Immutable
 private class DefaultMarkdownTypography(
     override val h1: TextStyle,