Skip to content

Commit 6c06237

Browse files
stevensJourneystevensJourney
committed
docs
1 parent c2a0115 commit 6c06237

File tree

13 files changed

+195
-3
lines changed

13 files changed

+195
-3
lines changed

‎build.gradle.kts

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,35 @@ subprojects {
6161
version = LIBRARY_VERSION
6262
}
6363

64-
tasks.register<Delete>("clean") {
64+
tasks.getByName<Delete>("clean") {
6565
delete(rootProject.layout.buildDirectory)
6666
}
6767

68+
buildscript {
69+
dependencies {
70+
classpath("org.jetbrains.dokka:dokka-base:2.0.0")
71+
}
72+
}
73+
74+
dokka {
75+
pluginsConfiguration.html {
76+
customAssets.from("./docs/assets/powersync-logo.png")
77+
customAssets.from("./docs/assets/discord.svg")
78+
customAssets.from("./docs/assets/github.svg")
79+
customAssets.from("./docs/assets/web.svg")
80+
customAssets.from("./docs/assets/x.svg")
81+
customAssets.from("./docs/assets/youtube.svg")
82+
customAssets.from("./docs/assets/linkedin.svg")
83+
customStyleSheets.from("./docs/assets/doc-styles.css")
84+
templatesDir = file("./docs/assets/dokka-templates")
85+
}
86+
}
87+
88+
dependencies {
89+
dokka(project(":core:"))
90+
dokka(project(":connectors:supabase"))
91+
}
92+
6893
tasks.register("serveDokka") {
6994
dependsOn("dokkaHtml")
7095
doLast {

‎connectors/supabase/build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ plugins {
88
alias(libs.plugins.androidLibrary)
99
alias(libs.plugins.kotlinter)
1010
id("com.powersync.plugins.sonatype")
11-
id("org.jetbrains.dokka")
11+
id("org.jetbrains.dokka") version "2.0.0"
1212
}
1313

1414
kotlin {

‎core/build.gradle.kts

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ plugins {
2020
id("com.powersync.plugins.sonatype")
2121
alias(libs.plugins.mokkery)
2222
alias(libs.plugins.kotlin.atomicfu)
23-
id("org.jetbrains.dokka")
23+
id("org.jetbrains.dokka") version "2.0.0"
2424
}
2525

2626
val binariesFolder = project.layout.buildDirectory.dir("binaries/desktop")
@@ -354,3 +354,17 @@ tasks.withType<KotlinTest> {
354354
}
355355
}
356356
setupGithubRepository()
357+
358+
dokka {
359+
pluginsConfiguration.html {
360+
customAssets.from("../docs/assets/powersync-logo.png")
361+
customAssets.from("../docs/assets/discord.svg")
362+
customAssets.from("../docs/assets/github.svg")
363+
customAssets.from("../docs/assets/web.svg")
364+
customAssets.from("../docs/assets/x.svg")
365+
customAssets.from("../docs/assets/youtube.svg")
366+
customAssets.from("../docs/assets/linkedin.svg")
367+
customStyleSheets.from("../docs/assets/doc-styles.css")
368+
templatesDir = file("../docs/assets/dokka-templates")
369+
}
370+
}

‎docs/assets/discord.svg

Lines changed: 18 additions & 0 deletions
Loading

‎docs/assets/doc-styles.css

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
:root {
2+
--dokka-logo-image-url: url('../images/powersync-logo.png');
3+
}
4+
5+
.footer-container {
6+
display: flex;
7+
flex-wrap: wrap;
8+
justify-content: center;
9+
gap: 8px;
10+
margin-top: auto;
11+
box-sizing: border-box;
12+
background-color: var(--footer-background);
13+
color: var(--footer-font-color);
14+
}
15+
16+
.footer-title {
17+
margin-bottom: 8px;
18+
}
19+
20+
.footer-column {
21+
flex: 1 1 0;
22+
align-items: center;
23+
text-align: center;
24+
min-width: 300px;
25+
padding: 8px;
26+
}
27+
28+
.footer-icon-row {
29+
display: flex;
30+
justify-content: center;
31+
align-items: center;
32+
gap: 8px;
33+
flex-wrap: wrap;
34+
}

‎docs/assets/dokka-templates/includes/footer.ftl

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<#macro display>
2+
<div style="margin-top:auto">
3+
4+
<div class="footer-container">
5+
<div class="footer-column">
6+
<strong class="footer-title">Community</strong>
7+
<div class="footer-icon-row">
8+
<a href="https://discord.gg/powersync" target="_blank">
9+
<img src="/images/discord.svg" loading="lazy" alt="Discord" height="24">
10+
</a>
11+
<a href="https://twitter.com/powersync_" target="_blank">
12+
<img src="/images/x.svg" loading="lazy" alt="Twitter" height="20">
13+
</a>
14+
<a href="https://www.youtube.com/@powersync_" target="_blank">
15+
<img src="/images/youtube.svg" loading="lazy" alt="YouTube" width="32" height="28">
16+
</a>
17+
<a href="https://www.linkedin.com/showcase/journeyapps-powersync/" target="_blank">
18+
<img src="/images/linkedin.svg" loading="lazy" alt="LinkedIn" height="24">
19+
</a>
20+
</div>
21+
</div>
22+
23+
<div class="footer-column">
24+
<strong class="footer-title">More</strong>
25+
<div class="footer-icon-row">
26+
<a href="https://github.com/powersync-ja" target="_blank">
27+
<img src="/images/github.svg" loading="lazy" alt="GitHub" height="24">
28+
</a>
29+
<a href="https://www.powersync.com/" target="_blank">
30+
<img src="/images/web.svg" loading="lazy" alt="Website" height="30">
31+
</a>
32+
</div>
33+
</div>
34+
</div>
35+
36+
<div class="footer-container">
37+
<span>© 2025 Journey Mobile, Inc.</span>
38+
<span class="pull-right">
39+
<span>Generated by </span>
40+
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
41+
<span>dokka</span>
42+
</a>
43+
</span>
44+
</div>
45+
46+
</div>
47+
</#macro>

‎docs/assets/github.svg

Lines changed: 22 additions & 0 deletions
Loading

‎docs/assets/linkedin.svg

Lines changed: 12 additions & 0 deletions
Loading

‎docs/assets/powersync-logo.png

53.2 KB
Loading

‎docs/assets/web.svg

Lines changed: 7 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)