Merge pull request #380 from mikepenz/develop

dev -> main

Author: mikepenz

.github/workflows/ci.yml

@@ -45,7 +45,7 @@ jobs:
             gradle-${{ runner.os }}-
 
       - name: Publish the macOS artifacts
-        if: matrix.os == 'macos-14'
+        if: matrix.os == 'macos-latest'
         env:
           ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.NEXUS_USERNAME }}
           ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.NEXUS_PASSWORD }}
@@ -174,4 +174,4 @@ jobs:
           prerelease: ${{ contains(github.ref, '-rc') || contains(github.ref, '-b') || contains(github.ref, '-a') }}
           files: artifacts/*
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -122,9 +122,16 @@ Markdown(markdownState)
 
 ### Parse Markdown in VM
 
+> [!NOTE]  
+> This approach is also advised if you want to retain scroll position even when navigating away
+> See: https://github.com/mikepenz/multiplatform-markdown-renderer/issues/374
+> Retaining state in the VM ensures parsing will not have to be done again, and the component can be
+> immediately filled.
+
 ```kotlin
 // In the VM setup the flow to parse the markdown
 val markdownFlow = parseMarkdownFlow("# Markdown")
+    .stateIn(lifecycleScope, SharingStarted.Eagerly, State.Loading())
 
 // In the Composable use the flow
 val state by markdownFlow.collectAsStateWithLifecycle(State.Loading())