Docs development (#202)

* add SnakeYAML Engine KMP to showcase * override fast-url-parser to prevent punycode warning
adamko-dev · Mar 24, 2024 · 8fa0d52 · 8fa0d52
1 parent 31ee8ed
commit 8fa0d52
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 13 deletions.
diff --git a/modules/docs/build.gradle.kts b/modules/docs/build.gradle.kts
@@ -123,4 +123,5 @@ tasks.screenshotter {
     "https://opensavvy.gitlab.io/automation/kotlin-js-resources/api-docs/"
   )
   website("mqtt-starter", "https://javadoc.io/doc/de.smartsquare/mqtt-starter/latest/index.html")
+  website("snakeyaml-engine-kmp", "https://krzema12.github.io/snakeyaml-engine-kmp/")
 }
diff --git a/modules/docs/site/package-lock.json b/modules/docs/site/package-lock.json
diff --git a/modules/docs/site/package.json b/modules/docs/site/package.json
@@ -37,6 +37,10 @@
     "@docusaurus/types": "3.1.1",
     "@tsconfig/docusaurus": "2.0.2"
   },
+  "// override fast-url-parser": "prevent warning about deprecated punycode",
+  "overrides": {
+    "fast-url-parser": "npm:@kamilkisiela/fast-url-parser@1.1.4"
+  },
   "browserslist": {
     "production": [
       ">0.5%",

diff --git a/modules/docs/site/src/data/showcase/snakeyaml-engine-kmp-dark.png b/modules/docs/site/src/data/showcase/snakeyaml-engine-kmp-dark.png
diff --git a/modules/docs/site/src/data/showcase/snakeyaml-engine-kmp-light.png b/modules/docs/site/src/data/showcase/snakeyaml-engine-kmp-light.png
diff --git a/modules/docs/site/src/data/users.tsx b/modules/docs/site/src/data/users.tsx
@@ -260,6 +260,20 @@ const Users: User[] = [
     source: "https://github.com/diffplug/selfie/tree/jvm/2.0.1/jvm/gradle/dokka",
     tags: ["favourite", "kotlinJvm", "html", "design"],
   },
+  {
+    title: "SnakeYAML Engine KMP",
+    description: "SnakeYAML Engine KMP is a YAML 1.2 processor for Kotlin Multiplatform.",
+    preview: <ThemedImage
+        alt={`SnakeYAML Engine KMP website screenshot`}
+        sources={{
+          light: require("./showcase/snakeyaml-engine-kmp-light.png").default,
+          dark: require("./showcase/snakeyaml-engine-kmp-dark.png").default,
+        }}
+    />,
+    website: "https://krzema12.github.io/snakeyaml-engine-kmp/",
+    source: "https://github.com/krzema12/snakeyaml-engine-kmp/blob/93035811240d755fedfc846191751e1b54b16e6c/build.gradle.kts",
+    tags: ["kotlinMultiplatform", "html"],
+  },
 
   // looks like a convention plugin, not an actual project
   // {