Skip to content

Commit cba42ff

Browse files
committed
Dokka: Link to source
1 parent 3e42e1f commit cba42ff

File tree

2 files changed

+26
-2
lines changed

2 files changed

+26
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,18 @@
66

77
# PowerSync Kotlin Multiplatform SDK
88

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

11-
See a summary of features [here](https://docs.powersync.com/client-sdk-references/kotlin-multiplatform#sdk-features).
11+
- Android
12+
- JVM
13+
- iOS
14+
- macOS
15+
- watchOS
16+
17+
If you need support for additional targets, please reach out!
18+
19+
See a summary of features [here](https://docs.powersync.com/client-sdk-references/kotlin-multiplatform#sdk-features)
20+
and API documentation [here](https://powersync-ja.github.io/powersync-kotlin/).
1221

1322
## Structure: Packages
1423

plugins/build-plugin/src/main/kotlin/dokka-convention.gradle.kts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ plugins {
44

55
// Shared Dokka config for additional assets
66
dokka {
7+
val commit = providers.exec {
8+
executable = "git"
9+
args("rev-parse", "HEAD")
10+
}.standardOutput.asText
11+
712
pluginsConfiguration.html {
813
val docsAssetsDir = rootProject.file("docs/assets")
914

@@ -18,4 +23,14 @@ dokka {
1823
customStyleSheets.from(docsAssetsDir.resolve("doc-styles.css"))
1924
templatesDir = file(docsAssetsDir.resolve("dokka-templates"))
2025
}
26+
27+
dokkaSourceSets.configureEach {
28+
sourceLink {
29+
localDirectory.set(project.rootDir)
30+
remoteUrl.set(commit.map { commit ->
31+
uri("https://github.com/powersync-ja/powersync-kotlin/tree/${commit.trim()}/")
32+
})
33+
remoteLineSuffix.set("#L")
34+
}
35+
}
2136
}

0 commit comments

Comments
 (0)