Conversation
Co-authored-by: renovate-mike[bot] <274037420+renovate-mike[bot]@users.noreply.github.com>
…digest to 53e4659
…ontainers-java-3-21 chore(deps): update mcr.microsoft.com/devcontainers/java:3-21 docker digest to 53e4659
fix(deps): update coil to v3.5.0
Adds a public top-level parseMarkdown(content, lookupLinks, flavour, parser, referenceLinkHandler): State alongside parseMarkdownFlow. It parses on the calling thread and returns the final immutable State directly (State.Success or State.Error), without exposing any mutable Flow/StateFlow surface. Useful to pre-parse content before the UI is shown and pass the parsed state into the Markdown composable. Reuses the existing Input / MarkdownStateImpl / parseBlocking path, so it is purely additive. Adds commonTest coverage and documents the function in the README. Closes #587
…down feat: add synchronous parseMarkdown returning a parsed State
Contributor
There was a problem hiding this comment.
Pull request overview
This PR merges dev -> main changes that introduce a synchronous markdown parsing entry point, document its usage, add test coverage for it, and roll forward a few release/dependency/CI environment updates.
Changes:
- Add new public top-level
parseMarkdown(...)API that parses markdown synchronously and returns a finalState(Success/Error). - Document synchronous parsing usage in the README and add
commonTestcoverage for success/link-lookup/error behavior. - Bump project version and update a dependency plus CI/devcontainer pinned revisions.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Documents the new synchronous parsing API and warns about running it off the main thread for large docs. |
multiplatform-markdown-renderer/src/commonTest/kotlin/com/mikepenz/markdown/model/ParseMarkdownTest.kt |
Adds tests covering success, empty input, reference-link lookup, and error-to-State.Error behavior. |
multiplatform-markdown-renderer/src/commonMain/kotlin/com/mikepenz/markdown/model/MarkdownState.kt |
Introduces the new public parseMarkdown(...) synchronous API backed by existing parseBlocking() behavior. |
multiplatform-markdown-renderer/api/multiplatform-markdown-renderer.klib.api |
Updates KLib API dump to include the new public function. |
multiplatform-markdown-renderer/api/jvm/multiplatform-markdown-renderer.api |
Updates JVM API dump to include the new public function. |
multiplatform-markdown-renderer/api/android/multiplatform-markdown-renderer.api |
Updates Android API dump to include the new public function. |
gradle/libs.versions.toml |
Bumps Coil v3 catalog version. |
gradle.properties |
Bumps library version name/code (0.42.0 → 0.43.0). |
.github/workflows/static.yml |
Updates pinned gradle/actions/setup-gradle revision. |
.github/workflows/gradle-dependency-submission.yml |
Updates pinned gradle/actions/setup-gradle revision. |
.github/workflows/ci.yml |
Updates pinned gradle/actions/setup-gradle and wrapper-validation revisions. |
.devcontainer/devcontainer.json |
Updates the pinned devcontainer image digest. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
dev -> main