Skip to content

Commit 5db5e70

Browse files
mikepenzmikepenz
authored
Merge pull request #409 from mikepenz/develop
dev -> main
2 parents 2ac5ce2 + ded3b68 commit 5db5e70

File tree

24 files changed

+513
-149
lines changed

24 files changed

+513
-149
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Steps to Reproduce
14+
15+
Steps to reproduce the behavior:
16+
17+
1. Add this code '...'
18+
2. Run on platform '...'
19+
3. See error
20+
21+
## Expected Behavior
22+
23+
A clear and concise description of what you expected to happen.
24+
25+
## Screenshots
26+
27+
If applicable, add screenshots to help explain your problem.
28+
29+
## Environment
30+
31+
- Library Version: [e.g. 0.34.0]
32+
- Platform: [e.g. Android, iOS, Desktop, Web]
33+
- Device: [e.g. Pixel 9, ...]
34+
- OS Version: [e.g. Android 16, ...]
35+
- Kotlin Version: [e.g. 2.1.20]
36+
- Compose Version: [e.g. 1.8.0]
37+
38+
## Additional Context
39+
40+
Add any other context about the problem here.
41+
42+
## Checklist
43+
44+
- [ ] I have searched
45+
for [similar issues](https://github.com/mikepenz/multiplatform-markdown-renderer/issues)
46+
- [ ] I have checked
47+
the [sample application](https://github.com/mikepenz/multiplatform-markdown-renderer/tree/develop/sample)
48+
- [ ] I have read
49+
the [README](https://github.com/mikepenz/multiplatform-markdown-renderer/blob/develop/README.md)
50+
- [ ] I have checked
51+
the [CHANGELOG](https://github.com/mikepenz/multiplatform-markdown-renderer/releases)
52+
- [ ] I have read
53+
the [MIGRATION GUIDE](https://github.com/mikepenz/multiplatform-markdown-renderer/blob/develop/MIGRATION.md)

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Documentation
4+
url: https://github.com/mikepenz/multiplatform-markdown-renderer/blob/develop/README.md
5+
about: Check out the project documentation for answers to common questions.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
A clear and concise description of the feature you're requesting.
12+
13+
## Problem Statement
14+
15+
A clear and concise description of what the problem is.
16+
17+
## Proposed Solution
18+
19+
A clear and concise description of what you want to happen.
20+
21+
## Alternatives Considered
22+
23+
A clear and concise description of any alternative solutions or features you've considered.
24+
25+
## Example Implementation
26+
27+
If applicable, provide a code example or mockup of how this feature would work.
28+
29+
## Use Case
30+
31+
Describe how this feature would be used and who would benefit from it.
32+
33+
## Additional Context
34+
35+
Add any other context or screenshots about the feature request here.
36+
37+
## Checklist
38+
39+
- [ ] I have searched
40+
for [similar feature requests](https://github.com/mikepenz/multiplatform-markdown-renderer/issues)
41+
- [ ] I have read
42+
the [README](https://github.com/mikepenz/multiplatform-markdown-renderer/blob/develop/README.md)
43+
- [ ] I have checked
44+
the [CHANGELOG](https://github.com/mikepenz/multiplatform-markdown-renderer/releases) to see if
45+
this feature is already planned

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Description
2+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
3+
4+
Fixes # (issue)
5+
6+
## Type of change
7+
Please delete options that are not relevant.
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
- [ ] Code style update (formatting, renaming)
14+
- [ ] Refactoring (no functional changes, no API changes)
15+
- [ ] Build configuration change
16+
- [ ] Other (please describe):
17+
18+
## How Has This Been Tested?
19+
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.
20+
21+
- [ ] Test A
22+
- [ ] Test B
23+
24+
## Checklist:
25+
- [ ] My code follows the style guidelines of this project
26+
- [ ] I have performed a self-review of my own code
27+
- [ ] I have commented my code, particularly in hard-to-understand areas
28+
- [ ] I have made corresponding changes to the documentation
29+
- [ ] My changes generate no new warnings
30+
- [ ] I have added tests that prove my fix is effective or that my feature works
31+
- [ ] New and existing unit tests pass locally with my changes
32+
- [ ] Any dependent changes have been merged and published in downstream modules

‎README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,15 @@
2929

3030
### What's included 🚀
3131

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

3642
-------
3743

‎SECURITY.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ Patches will be released to the latest major version.
66

77
## Reporting a Vulnerability
88

9-
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.
9+
Please report (suspected) security vulnerabilities to opensource-sec@mikepenz.dev. If the issue is
10+
confirmed, we will release a patch as soon as possible depending on complexity.

‎build.gradle.kts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ plugins {
66
alias(baseLibs.plugins.androidLibrary) apply false
77
alias(baseLibs.plugins.composeMultiplatform) apply false
88
alias(baseLibs.plugins.composeCompiler) apply false
9+
alias(baseLibs.plugins.composeHotreload) apply false
910
alias(baseLibs.plugins.kotlinMultiplatform) apply false
1011
alias(baseLibs.plugins.dokka)
1112
alias(baseLibs.plugins.aboutLibraries) apply false

‎gradle.properties

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Maven stuff
22
GROUP=com.mikepenz
3-
VERSION_NAME=0.34.0
4-
VERSION_CODE=3400
3+
VERSION_NAME=0.35.0
4+
VERSION_CODE=3500
55
#
66
POM_URL=https://github.com/mikepenz/multiplatform-markdown-renderer
77
POM_SCM_URL=https://github.com/mikepenz/multiplatform-markdown-renderer

‎multiplatform-markdown-renderer/api/android/multiplatform-markdown-renderer.api

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public final class com/mikepenz/markdown/compose/LazyMarkdownKt {
6363
}
6464

6565
public final class com/mikepenz/markdown/compose/MarkdownExtensionKt {
66-
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
66+
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
6767
}
6868

6969
public final class com/mikepenz/markdown/compose/MarkdownKt {
@@ -575,19 +575,17 @@ public final class com/mikepenz/markdown/model/MarkdownPaddingKt {
575575
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;
576576
}
577577

578-
public final class com/mikepenz/markdown/model/MarkdownState {
579-
public static final field $stable I
580-
public fun <init> (Lcom/mikepenz/markdown/model/Input;)V
581-
public final fun getInput ()Lcom/mikepenz/markdown/model/Input;
582-
public final fun getLinks ()Lkotlinx/coroutines/flow/StateFlow;
583-
public final fun getState ()Lkotlinx/coroutines/flow/StateFlow;
584-
public final fun parse (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
578+
public abstract interface class com/mikepenz/markdown/model/MarkdownState {
579+
public abstract fun getLinks ()Lkotlinx/coroutines/flow/StateFlow;
580+
public abstract fun getState ()Lkotlinx/coroutines/flow/StateFlow;
581+
public abstract fun parse (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
585582
}
586583

587584
public final class com/mikepenz/markdown/model/MarkdownStateKt {
588585
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;
589586
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;
590587
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;
588+
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;
591589
}
592590

593591
public abstract interface class com/mikepenz/markdown/model/MarkdownTypography {

‎multiplatform-markdown-renderer/api/jvm/multiplatform-markdown-renderer.api

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public final class com/mikepenz/markdown/compose/LazyMarkdownKt {
6363
}
6464

6565
public final class com/mikepenz/markdown/compose/MarkdownExtensionKt {
66-
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
66+
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
6767
}
6868

6969
public final class com/mikepenz/markdown/compose/MarkdownKt {
@@ -575,19 +575,17 @@ public final class com/mikepenz/markdown/model/MarkdownPaddingKt {
575575
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;
576576
}
577577

578-
public final class com/mikepenz/markdown/model/MarkdownState {
579-
public static final field $stable I
580-
public fun <init> (Lcom/mikepenz/markdown/model/Input;)V
581-
public final fun getInput ()Lcom/mikepenz/markdown/model/Input;
582-
public final fun getLinks ()Lkotlinx/coroutines/flow/StateFlow;
583-
public final fun getState ()Lkotlinx/coroutines/flow/StateFlow;
584-
public final fun parse (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
578+
public abstract interface class com/mikepenz/markdown/model/MarkdownState {
579+
public abstract fun getLinks ()Lkotlinx/coroutines/flow/StateFlow;
580+
public abstract fun getState ()Lkotlinx/coroutines/flow/StateFlow;
581+
public abstract fun parse (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
585582
}
586583

587584
public final class com/mikepenz/markdown/model/MarkdownStateKt {
588585
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;
589586
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;
590587
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;
588+
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;
591589
}
592590

593591
public abstract interface class com/mikepenz/markdown/model/MarkdownTypography {

0 commit comments

Comments
 (0)