Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
d436a35
fixed small images rendering
devDebajo May 25, 2025
a122d5f
Merge pull request #402 from devDebajo/fix/images-very-small
mikepenz May 25, 2025
1f32ca0
Fix: Recompose `MarkdownText` on `imageState` change
mikepenz May 25, 2025
f421467
- update version-catalog including the new compose 1.8.2 release
mikepenz May 25, 2025
3494d9b
Merge pull request #403 from mikepenz/feature/compose_update
mikepenz May 25, 2025
2996147
- refine README
mikepenz May 25, 2025
812ecb3
- refine documentation
mikepenz May 25, 2025
5f0d68f
- fix documentation
mikepenz May 25, 2025
811dd55
Merge pull request #404 from mikepenz/feature/cleanup
mikepenz May 25, 2025
e994eac
- add bug report, feature request templates
mikepenz May 25, 2025
a644085
Merge pull request #405 from mikepenz/feature/contribution
mikepenz May 25, 2025
781ea45
- update security.md e-mail
mikepenz May 25, 2025
8367f95
- add pull request template
mikepenz May 25, 2025
b71c586
- add compose hot reload
mikepenz May 25, 2025
77b4576
Merge pull request #406 from mikepenz/feature/contribution
mikepenz May 25, 2025
0fb86e4
Merge pull request #407 from mikepenz/feature/compose_hot_relaod
mikepenz May 25, 2025
2710b00
- add remember to skip creation of new `MarkdownComponentModel` if no…
mikepenz May 25, 2025
f450216
- slightly optimize LazyMarkdownSuccess
mikepenz May 25, 2025
e4e81aa
- add `rememberMarkdownState` accepting a suspending block to load th…
mikepenz May 25, 2025
1cdeba8
- update *.api
mikepenz May 25, 2025
529c5b9
- update to the latest aboutLibraries version
mikepenz May 25, 2025
2bbab59
- simplify about libs spec
mikepenz May 25, 2025
571741a
Merge pull request #408 from mikepenz/feature/optimisation
mikepenz May 25, 2025
ded3b68
- [release] v0.35.0
mikepenz May 25, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---

## Bug Description

A clear and concise description of what the bug is.

## Steps to Reproduce

Steps to reproduce the behavior:

1. Add this code '...'
2. Run on platform '...'
3. See error

## Expected Behavior

A clear and concise description of what you expected to happen.

## Screenshots

If applicable, add screenshots to help explain your problem.

## Environment

- Library Version: [e.g. 0.34.0]
- Platform: [e.g. Android, iOS, Desktop, Web]
- Device: [e.g. Pixel 9, ...]
- OS Version: [e.g. Android 16, ...]
- Kotlin Version: [e.g. 2.1.20]
- Compose Version: [e.g. 1.8.0]

## Additional Context

Add any other context about the problem here.

## Checklist

- [ ] I have searched
for [similar issues](https://github.com/mikepenz/multiplatform-markdown-renderer/issues)
- [ ] I have checked
the [sample application](https://github.com/mikepenz/multiplatform-markdown-renderer/tree/develop/sample)
- [ ] I have read
the [README](https://github.com/mikepenz/multiplatform-markdown-renderer/blob/develop/README.md)
- [ ] I have checked
the [CHANGELOG](https://github.com/mikepenz/multiplatform-markdown-renderer/releases)
- [ ] I have read
the [MIGRATION GUIDE](https://github.com/mikepenz/multiplatform-markdown-renderer/blob/develop/MIGRATION.md)
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Documentation
url: https://github.com/mikepenz/multiplatform-markdown-renderer/blob/develop/README.md
about: Check out the project documentation for answers to common questions.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---

## Feature Description

A clear and concise description of the feature you're requesting.

## Problem Statement

A clear and concise description of what the problem is.

## Proposed Solution

A clear and concise description of what you want to happen.

## Alternatives Considered

A clear and concise description of any alternative solutions or features you've considered.

## Example Implementation

If applicable, provide a code example or mockup of how this feature would work.

## Use Case

Describe how this feature would be used and who would benefit from it.

## Additional Context

Add any other context or screenshots about the feature request here.

## Checklist

- [ ] I have searched
for [similar feature requests](https://github.com/mikepenz/multiplatform-markdown-renderer/issues)
- [ ] I have read
the [README](https://github.com/mikepenz/multiplatform-markdown-renderer/blob/develop/README.md)
- [ ] I have checked
the [CHANGELOG](https://github.com/mikepenz/multiplatform-markdown-renderer/releases) to see if
this feature is already planned
32 changes: 32 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

Fixes # (issue)

## Type of change
Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Code style update (formatting, renaming)
- [ ] Refactoring (no functional changes, no API changes)
- [ ] Build configuration change
- [ ] Other (please describe):

## How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

- [ ] Test A
- [ ] Test B

## Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,15 @@

### What's included 🚀

- Super simple setup
- Cross-platform ready
- Lightweight
- **Cross-platform Markdown Rendering** - Works on Android, iOS, Desktop, and Web
- **Material Design Integration** - Seamless integration with Material 2 and Material 3 themes
- **Rich Markdown Support** - Renders headings, lists, code blocks, tables, images, and more
- **Syntax Highlighting** - Optional code syntax highlighting for various programming languages
- **Image Loading** - Flexible image loading with Coil2 and Coil3 integration
- **Customization Options** - Extensive customization for colors, typography, components, and more
- **Performance Optimized** - Efficient rendering with lazy loading support for large documents
- **Extended Text Spans** - Support for advanced text styling with extended spans
- **Lightweight** - Minimal dependencies and optimized for performance

-------

Expand Down
3 changes: 2 additions & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ Patches will be released to the latest major version.

## Reporting a Vulnerability

Please report (suspected) security vulnerabilities to mikepenz+osss@gmail.com. If the issue is confirmed, we will release a patch as soon as possible depending on complexity.
Please report (suspected) security vulnerabilities to opensource-sec@mikepenz.dev. If the issue is
confirmed, we will release a patch as soon as possible depending on complexity.
1 change: 1 addition & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ plugins {
alias(baseLibs.plugins.androidLibrary) apply false
alias(baseLibs.plugins.composeMultiplatform) apply false
alias(baseLibs.plugins.composeCompiler) apply false
alias(baseLibs.plugins.composeHotreload) apply false
alias(baseLibs.plugins.kotlinMultiplatform) apply false
alias(baseLibs.plugins.dokka)
alias(baseLibs.plugins.aboutLibraries) apply false
Expand Down
4 changes: 2 additions & 2 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Maven stuff
GROUP=com.mikepenz
VERSION_NAME=0.34.0
VERSION_CODE=3400
VERSION_NAME=0.35.0
VERSION_CODE=3500
#
POM_URL=https://github.com/mikepenz/multiplatform-markdown-renderer
POM_SCM_URL=https://github.com/mikepenz/multiplatform-markdown-renderer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public final class com/mikepenz/markdown/compose/LazyMarkdownKt {
}

public final class com/mikepenz/markdown/compose/MarkdownExtensionKt {
public static final fun MarkdownElement (Lorg/intellij/markdown/ast/ASTNode;Lcom/mikepenz/markdown/compose/components/MarkdownComponents;Ljava/lang/String;ZZLandroidx/compose/runtime/Composer;II)Z
public static final fun MarkdownElement (Lorg/intellij/markdown/ast/ASTNode;Lcom/mikepenz/markdown/compose/components/MarkdownComponents;Ljava/lang/String;ZZLandroidx/compose/runtime/Composer;II)V
}

public final class com/mikepenz/markdown/compose/MarkdownKt {
Expand Down Expand Up @@ -575,19 +575,17 @@ public final class com/mikepenz/markdown/model/MarkdownPaddingKt {
public static final fun markdownPadding-hBH8OFI (FFFFLandroidx/compose/ui/unit/Dp;FLandroidx/compose/foundation/layout/PaddingValues;Landroidx/compose/foundation/layout/PaddingValues;Landroidx/compose/foundation/layout/PaddingValues;Landroidx/compose/foundation/layout/PaddingValues$Absolute;Landroidx/compose/runtime/Composer;II)Lcom/mikepenz/markdown/model/MarkdownPadding;
}

public final class com/mikepenz/markdown/model/MarkdownState {
public static final field $stable I
public fun <init> (Lcom/mikepenz/markdown/model/Input;)V
public final fun getInput ()Lcom/mikepenz/markdown/model/Input;
public final fun getLinks ()Lkotlinx/coroutines/flow/StateFlow;
public final fun getState ()Lkotlinx/coroutines/flow/StateFlow;
public final fun parse (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract interface class com/mikepenz/markdown/model/MarkdownState {
public abstract fun getLinks ()Lkotlinx/coroutines/flow/StateFlow;
public abstract fun getState ()Lkotlinx/coroutines/flow/StateFlow;
public abstract fun parse (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
}

public final class com/mikepenz/markdown/model/MarkdownStateKt {
public static final fun parseMarkdownFlow (Ljava/lang/String;ZLorg/intellij/markdown/flavours/MarkdownFlavourDescriptor;Lorg/intellij/markdown/parser/MarkdownParser;Lcom/mikepenz/markdown/model/ReferenceLinkHandler;)Lkotlinx/coroutines/flow/Flow;
public static synthetic fun parseMarkdownFlow$default (Ljava/lang/String;ZLorg/intellij/markdown/flavours/MarkdownFlavourDescriptor;Lorg/intellij/markdown/parser/MarkdownParser;Lcom/mikepenz/markdown/model/ReferenceLinkHandler;ILjava/lang/Object;)Lkotlinx/coroutines/flow/Flow;
public static final fun rememberMarkdownState (Ljava/lang/String;ZLorg/intellij/markdown/flavours/MarkdownFlavourDescriptor;Lorg/intellij/markdown/parser/MarkdownParser;Lcom/mikepenz/markdown/model/ReferenceLinkHandler;ZLandroidx/compose/runtime/Composer;II)Lcom/mikepenz/markdown/model/MarkdownState;
public static final fun rememberMarkdownState (ZLorg/intellij/markdown/flavours/MarkdownFlavourDescriptor;Lorg/intellij/markdown/parser/MarkdownParser;Lcom/mikepenz/markdown/model/ReferenceLinkHandler;Lkotlin/jvm/functions/Function1;Landroidx/compose/runtime/Composer;II)Lcom/mikepenz/markdown/model/MarkdownState;
}

public abstract interface class com/mikepenz/markdown/model/MarkdownTypography {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public final class com/mikepenz/markdown/compose/LazyMarkdownKt {
}

public final class com/mikepenz/markdown/compose/MarkdownExtensionKt {
public static final fun MarkdownElement (Lorg/intellij/markdown/ast/ASTNode;Lcom/mikepenz/markdown/compose/components/MarkdownComponents;Ljava/lang/String;ZZLandroidx/compose/runtime/Composer;II)Z
public static final fun MarkdownElement (Lorg/intellij/markdown/ast/ASTNode;Lcom/mikepenz/markdown/compose/components/MarkdownComponents;Ljava/lang/String;ZZLandroidx/compose/runtime/Composer;II)V
}

public final class com/mikepenz/markdown/compose/MarkdownKt {
Expand Down Expand Up @@ -575,19 +575,17 @@ public final class com/mikepenz/markdown/model/MarkdownPaddingKt {
public static final fun markdownPadding-hBH8OFI (FFFFLandroidx/compose/ui/unit/Dp;FLandroidx/compose/foundation/layout/PaddingValues;Landroidx/compose/foundation/layout/PaddingValues;Landroidx/compose/foundation/layout/PaddingValues;Landroidx/compose/foundation/layout/PaddingValues$Absolute;Landroidx/compose/runtime/Composer;II)Lcom/mikepenz/markdown/model/MarkdownPadding;
}

public final class com/mikepenz/markdown/model/MarkdownState {
public static final field $stable I
public fun <init> (Lcom/mikepenz/markdown/model/Input;)V
public final fun getInput ()Lcom/mikepenz/markdown/model/Input;
public final fun getLinks ()Lkotlinx/coroutines/flow/StateFlow;
public final fun getState ()Lkotlinx/coroutines/flow/StateFlow;
public final fun parse (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract interface class com/mikepenz/markdown/model/MarkdownState {
public abstract fun getLinks ()Lkotlinx/coroutines/flow/StateFlow;
public abstract fun getState ()Lkotlinx/coroutines/flow/StateFlow;
public abstract fun parse (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
}

public final class com/mikepenz/markdown/model/MarkdownStateKt {
public static final fun parseMarkdownFlow (Ljava/lang/String;ZLorg/intellij/markdown/flavours/MarkdownFlavourDescriptor;Lorg/intellij/markdown/parser/MarkdownParser;Lcom/mikepenz/markdown/model/ReferenceLinkHandler;)Lkotlinx/coroutines/flow/Flow;
public static synthetic fun parseMarkdownFlow$default (Ljava/lang/String;ZLorg/intellij/markdown/flavours/MarkdownFlavourDescriptor;Lorg/intellij/markdown/parser/MarkdownParser;Lcom/mikepenz/markdown/model/ReferenceLinkHandler;ILjava/lang/Object;)Lkotlinx/coroutines/flow/Flow;
public static final fun rememberMarkdownState (Ljava/lang/String;ZLorg/intellij/markdown/flavours/MarkdownFlavourDescriptor;Lorg/intellij/markdown/parser/MarkdownParser;Lcom/mikepenz/markdown/model/ReferenceLinkHandler;ZLandroidx/compose/runtime/Composer;II)Lcom/mikepenz/markdown/model/MarkdownState;
public static final fun rememberMarkdownState (ZLorg/intellij/markdown/flavours/MarkdownFlavourDescriptor;Lorg/intellij/markdown/parser/MarkdownParser;Lcom/mikepenz/markdown/model/ReferenceLinkHandler;Lkotlin/jvm/functions/Function1;Landroidx/compose/runtime/Composer;II)Lcom/mikepenz/markdown/model/MarkdownState;
}

public abstract interface class com/mikepenz/markdown/model/MarkdownTypography {
Expand Down
Loading