Customize KDoc (#34)

diffplug · Oct 12, 2023 · d8b7400 · d8b7400
2 parents 060bd31 + da8e7e5
commit d8b7400
Show file tree

Hide file tree

Showing 20 changed files with 1,037 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 .gradle/
 build/
 bin/
+.DS_Store
diff --git a/build.gradle b/build.gradle
@@ -5,3 +5,31 @@ repositories {
   mavenCentral()
 }
 apply from: rootProject.file('gradle/spotless.gradle')
+
+// ./gradlew :dokkatooGeneratePublicationHtml
+//     https://github.com/Kotlin/dokka/issues/3131
+// if IntelliJ is running, then you'll also get a localhost server link
+def HAS_DOCS = [
+  'selfie-lib',
+  'selfie-runner-junit5'
+]
+subprojects {
+  if (name in HAS_DOCS) {
+    apply from: rootProject.file("gradle/dokka/dokkatoo.gradle")
+  }
+}
+apply from: rootProject.file("gradle/dokka/dokkatoo.gradle")
+dependencies {
+  // aggregate both subproject-hello and subproject-world
+  // the subprojects must also have Dokkatoo applied
+  for (p in HAS_DOCS) {
+    dokkatoo(project(":${p}"))
+  }
+
+  // This is required at the moment, see https://github.com/adamko-dev/dokkatoo/issues/14
+  dokkatooPluginHtml(
+      dokkatoo.versions.jetbrainsDokka.map { dokkaVersion ->
+        "org.jetbrains.dokka:all-modules-page-plugin:$dokkaVersion"
+      }
+      )
+}
diff --git a/docs/public/logo-icon-large.svg b/docs/public/logo-icon-large.svg
diff --git a/docs/public/logo-icon.svg b/docs/public/logo-icon.svg
diff --git a/docs/src/pages/_document.tsx b/docs/src/pages/_document.tsx
@@ -10,6 +10,12 @@ export default function Document() {
           href="https://fonts.googleapis.com/css2?family=Bagel+Fat+One&family=Jost:ital,wght@0,400;0,700;1,400&display=swap"
           rel="stylesheet"
         />
+        <link
+          href="/logo-icon.svg"
+          rel="icon"
+          type="image/svg"
+          sizes="32x32"
+        ></link>
       </Head>
       <body>
         <div className="flex justify-center text-black antialiased">

diff --git a/gradle/dokka/README.md b/gradle/dokka/README.md
@@ -0,0 +1,9 @@
+Main info is available at https://kotlinlang.org/docs/dokka-html.html
+
+But the gist is that [this folder](https://github.com/Kotlin/dokka/tree/master/plugins/base/src/main/resources/dokka) has
+
+- images (mainly `logo-icon.svg`)
+- styles (`style.css`, `prism.css` (syntax highlighting), `logo-styles.css`)
+- templates (`base.ftl`, `header.ftl`, `footer.ftl`)
+
+And we can override any of them in the root `build.gradle` inside the `dokkatoo` blocks.
diff --git a/gradle/dokka/assets/antique_bot.webp b/gradle/dokka/assets/antique_bot.webp
diff --git a/gradle/dokka/assets/antique_humanoid.webp b/gradle/dokka/assets/antique_humanoid.webp
diff --git a/gradle/dokka/assets/background_floral.webp b/gradle/dokka/assets/background_floral.webp
diff --git a/gradle/dokka/assets/background_seaside.webp b/gradle/dokka/assets/background_seaside.webp
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,3 +2,4 @@ @@
     .gradle/
     build/
     bin/
+    .DS_Store