Merge pull request #48 from openai/dev/rz/upstream-merge

Merge from upstream, including updated dependencies

Author: rz-openai

.github/workflows/android.yml

@@ -11,10 +11,10 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: gradle/wrapper-validation-action@v1
-      - name: set up JDK 17
+      - name: set up JDK 21
         uses: actions/setup-java@v1
         with:
-          java-version: 17
+          java-version: 21
       - uses: actions/cache@v4
         with:
           path: ~/.gradle/caches

.github/workflows/docs.yml

@@ -16,12 +16,12 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-java@v1
         with:
-          java-version: 17
+          java-version: 21
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
       - name: Install dependencies
         run: pip install mkdocs-material
       - name: Generate docs
-        run: ./gen_docs.sh
+        run: ./gen_dokka_docs.sh
       - run: mkdocs gh-deploy --force

.gitignore

@@ -22,3 +22,5 @@ build/
 /captures
 .externalNativeBuild
 .cxx
+site/
+docs-gen/

CHANGELOG.md

@@ -1,6 +1,29 @@
 Changelog
 =========
 
+1.0.0-alpha03
+-------
+
+This release removes the `printing` and `slideshow` modules to focus on the core Markdown and RichText functionalities. It also adds support for inline base64 images.
+
+### Breaking Changes
+- The `printing` and `slideshow` modules have been removed. If you were using them, you will need to find an alternative or use a previous version of the library.
+
+### New Features
+- **Inline Base64 Image Rendering**: Markdown images can now be rendered from inline base64-encoded data URIs.
+
+### Updates & Maintenance
+- **Dependencies Updated**:
+    - Compose Multiplatform updated to `1.8.2`.
+    - Commonmark updated to `0.25.0`.
+    - Dokka updated to `2.0.0`.
+- **Build & CI**:
+    - Android Gradle Plugin and other dependencies have been updated.
+    - CI now uses `actions/cache@v4`.
+- **Sample App**:
+    - The Android sample app has been updated to reflect the removal of the `printing` and `slideshow` modules.
+    - Theme handling in the sample app has been simplified.
+
 v0.11.0
 ------
 
@@ -64,24 +87,13 @@ Special thanks @zach-klippenstein @LouisCAD @russhwolf for their reviews and hel
 v0.7.0
 ------
 
-_2021-9-1_
-
-* Improved markdown rendering for editor like environments (#46)
-* Finalized MaterialRichText API. (#47)
-  * Move from BasicRichText/RichText to RichText/MaterialRichText + SetupMaterialRichText
-  * Update docs accordingly
-* Cleaned RichTextString rendering from hacks that were left from earlier compose versions (#48)
-
-v0.6.0
-------
-
 _2021-8-6_
 
 * RichText UI no longer depends on Material (#45)
 * A new artifact richtext-ui-material is published to easily integrate RichText for apps that use Material design.
 * Upgraded compose to 1.0.1 and kotlin to 1.5.21
 
-v0.5.0
+v0.6.0
 ------
 
 _2021-7-29_
@@ -93,7 +105,7 @@ _2021-7-29_
 * Artifacts have moved from com.zachklipp.compose-richtext to com.halilibo.compose-richtext.
 * Similarly, documentation is also now available at halilibo.com/compose-richtext
 
-v0.3.0
+v0.5.0
 ------
 
 _2021-5-18_
@@ -117,4 +129,4 @@ _2020-11-06_
 
 * Initial release.
 
-Thanks to @halilozercan for implementing Markdown support!
+Thanks to @halilozercan for implementing Markdown support!

README.md

@@ -1,17 +1,14 @@
-# compose-richtext
+# Compose Markdown and Rich Text
 
 [![Maven Central](https://img.shields.io/maven-central/v/com.halilibo.compose-richtext/richtext-ui.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.halilibo.compose-richtext%22)
 [![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](https://www.apache.org/licenses/LICENSE-2.0)
 
 > **Warning**
 > compose-richtext library and all its modules are very experimental. The roadmap is unclear at the moment. Thanks for your patience. Fork option is available as always.
 
-A collection of Compose libraries for working with rich text formatting and documents.
+A collection of Compose libraries for working with Markdown rendering and rich text formatting.
 
-Aside from `printing`, and `slideshow`, all modules are Kotlin Multiplatform Compose Libraries.
-
-This repo is currently very experimental and really just proofs-of-concept: there are no tests and some things
-might be broken or very non-performant.
+All modules are Compose Multiplatform compatible but lacks iOS support.
 
 ----
 
@@ -21,30 +18,24 @@ might be broken or very non-performant.
 
 ```kotlin
 @Composable fun App() {
-  val printController = rememberPrintableController()
-
-  Printable(printController) {
-    RichText(Modifier.background(color = Color.White)) {
-      Heading(0, "Title")
-      Text("Summary paragraph.")
+  RichText(Modifier.background(color = Color.LightGray)) {
+    Heading(0, "Title")
+    Text("Summary paragraph.")
 
-      HorizontalRule()
+    HorizontalRule()
 
-      BlockQuote {
-        Text("A wise person once said…")
-      }
+    BlockQuote {
+      Text("A wise person once said…")
     }
-  }
-
-  Button(onClick = { printController.print("README") }) {
-    Text("PRINT ME")
+    
+    Markdown("**Hello** `World`")
   }
 }
 ```
 
 ## License
 ```
-Copyright 2022 Halil Ozercan
+Copyright 2025 Halil Ozercan
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

android-sample/build.gradle.kts

@@ -1,3 +1,5 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
 plugins {
   id("com.android.application")
   kotlin("android")
@@ -22,16 +24,17 @@ android {
     sourceCompatibility = JavaVersion.VERSION_11
     targetCompatibility = JavaVersion.VERSION_11
   }
-  kotlinOptions {
-    jvmTarget = "11"
+}
+
+kotlin {
+  compilerOptions {
+    jvmTarget = JvmTarget.JVM_11
   }
 }
 
 dependencies {
-  implementation(project(":printing"))
   implementation(project(":richtext-commonmark"))
   implementation(project(":richtext-ui-material3"))
-  implementation(project(":slideshow"))
   implementation(AndroidX.appcompat)
   implementation(Compose.activity)
   implementation(compose.foundation)