Skip to content

Project cleanup / refinement #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 25, 2025
Merged

Project cleanup / refinement #404

merged 3 commits into from
May 25, 2025

Conversation

mikepenz
Copy link
Owner

No description provided.

@mikepenz mikepenz requested a review from Copilot May 25, 2025 10:46
@mikepenz mikepenz added the other label May 25, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@mikepenz mikepenz merged commit 811dd55 into develop May 25, 2025
3 checks passed
@mikepenz mikepenz deleted the feature/cleanup branch May 25, 2025 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant