Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refines the project by improving documentation and adding helper composable functions to enhance clarity and consistency in the markdown rendering API while also updating the feature list in the README.
- Adds a new helper composable, rememberMarkdownImageState, with detailed documentation.
- Updates documentation for multiple overloads of the Markdown composable for clearer usage and examples.
- Enhances the README with a more comprehensive and formatted list of key features.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| multiplatform-markdown-renderer/src/commonMain/kotlin/com/mikepenz/markdown/model/MarkdownImageState.kt | Added a new helper composable to create and remember MarkdownImageState with complete documentation. |
| multiplatform-markdown-renderer/src/commonMain/kotlin/com/mikepenz/markdown/compose/Markdown.kt | Improved and expanded documentation for Markdown composable overloads covering various use cases. |
| README.md | Updated the feature list with additional key points for a clearer presentation of project capabilities. |
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.
No description provided.