diff --git a/markdown/README.md b/markdown/README.md index 4f5b3800f..b5a43c7ba 100644 --- a/markdown/README.md +++ b/markdown/README.md @@ -45,6 +45,23 @@ Not supported, and not on the roadmap: * 3D STL models (GitHub Flavored Markdown) * Rich rendering of embeds such as videos, YouTube, GitHub Gists/... +## Add the Markdown renderer to your project + +You need to add the renderer **alongside** either a `jewel-standalone` or `jewel-ide-laf-bridge-*` dependency in order +for the renderer to work, as it assumes that the necessary `jewel-ui` and `jewel-foundation` are on the classpath +already. + +If you want to use extensions, you also need to add them **alongside** the `jewel-markdown-core`: + +```kotlin +dependencies { + implementation(libs.jewel.standalone) + implementation(libs.jewel.markdown.core) + implementation(libs.jewel.markdown.extension.gfm.alerts) // Optional + // Et cetera... +} +``` + ## How to use Jewel's Markdown renderer The process that leads to rendering Markdown in a native UI is two-pass. diff --git a/markdown/extension-gfm-alerts/build.gradle.kts b/markdown/extension-gfm-alerts/build.gradle.kts index fb5ef4bdd..def637ace 100644 --- a/markdown/extension-gfm-alerts/build.gradle.kts +++ b/markdown/extension-gfm-alerts/build.gradle.kts @@ -6,9 +6,10 @@ plugins { } dependencies { + // This extension should get all dependencies from ui and markdown-core + compileOnly(projects.ui) compileOnly(projects.markdown.core) - - implementation(libs.commonmark.core) + compileOnly(libs.commonmark.core) testImplementation(compose.desktop.uiTestJUnit4) }