Skip to content

Dokka: Link to source #226

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 1 commit into from
Jul 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,18 @@

# PowerSync Kotlin Multiplatform SDK

This is the PowerSync client SDK for Kotlin Mutliplatform. This SDK currently supports Android and iOS as targets.
This is the PowerSync client SDK for Kotlin. This SDK currently supports the following Kotlin targets:

See a summary of features [here](https://docs.powersync.com/client-sdk-references/kotlin-multiplatform#sdk-features).
- Android
- JVM
- iOS
- macOS
- watchOS

If you need support for additional targets, please reach out!

See a summary of features [here](https://docs.powersync.com/client-sdk-references/kotlin-multiplatform#sdk-features)
and API documentation [here](https://powersync-ja.github.io/powersync-kotlin/).

## Structure: Packages

Expand Down
15 changes: 15 additions & 0 deletions plugins/build-plugin/src/main/kotlin/dokka-convention.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ plugins {

// Shared Dokka config for additional assets
dokka {
val commit = providers.exec {
executable = "git"
args("rev-parse", "HEAD")
}.standardOutput.asText

pluginsConfiguration.html {
val docsAssetsDir = rootProject.file("docs/assets")

Expand All @@ -18,4 +23,14 @@ dokka {
customStyleSheets.from(docsAssetsDir.resolve("doc-styles.css"))
templatesDir = file(docsAssetsDir.resolve("dokka-templates"))
}

dokkaSourceSets.configureEach {
sourceLink {
localDirectory.set(project.rootDir)
remoteUrl.set(commit.map { commit ->
uri("https://github.com/powersync-ja/powersync-kotlin/tree/${commit.trim()}/")
})
remoteLineSuffix.set("#L")
}
}
}
Loading