Add a site that includes both the API documentation and the demo, including an index.html and a Gradle task to generate the site, and update the workflow file correspondingly

ShreckYe · ShreckYe · commit a1f4168de1bf · 2024-11-06T10:54:45.000+08:00
diff --git a/.github/workflows/dokka-gh-pages.yml b/.github/workflows/dokka-gh-pages.yml
@@ -1,4 +1,4 @@
-name: Deploy the API documentation to GitHub Pages with Dokka
+name: Deploy the site to GitHub Pages
 
 on:
   push:
@@ -41,12 +41,12 @@ jobs:
         uses: gradle/actions/setup-gradle@v4
 
       - name: Build the distribution with Gradle Wrapper
-        run: ./gradlew :dokkaGeneratePublicationHtml
+        run: ./gradlew :generateSite
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: build/dokka/html/
+          path: build/site/
 
   # Deployment job
   deploy:
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,3 +1,5 @@
+import org.jetbrains.dokka.gradle.tasks.DokkaGeneratePublicationTask
+
 tasks.wrapper {
     distributionType = Wrapper.DistributionType.ALL
 }
@@ -14,3 +16,15 @@ dependencies {
         dokka(project(":$it"))
     }
 }
+
+val dokkaGeneratePublicationHtml by tasks.getting(DokkaGeneratePublicationTask::class)
+tasks.register<Sync>("generateSite") {
+    group = "site"
+
+    val destRootDir = layout.buildDirectory.dir("site")
+    into(destRootDir)
+    from(dokkaGeneratePublicationHtml) {
+        into("api-documentation")
+    }
+    from(layout.projectDirectory.dir("site"))
+}
diff --git a/site/index.html b/site/index.html
@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+    <meta charset="UTF-8">
+    <title>Compose HTML Material</title>
+    <meta content="width=device-width, initial-scale=1" name="viewport">
+    <style>
+        body {
+            margin: 0;
+            height: 100vh;
+            display: flex;
+            justify-content: center;
+            align-items: center;
+        }
+    </style>
+</head>
+
+<body>
+    <ul>
+        <li><a href="api-documentation/index.html">API documentation</a></li>
+        <li>
+            <a href="https://huanshankeji.github.io/compose-multiplatform-material/">
+                Compose Multiplatform Material side-by-side demo
+            </a>
+        </li>
+    </ul>
+</body>
+
+</html>
