move to starlight

GradleUp · Jan 5, 2025 · 2501b67 · 2501b67
1 parent 58e47c6
commit 2501b67
Show file tree

Hide file tree

Showing 20 changed files with 97 additions and 161 deletions.
diff --git a/...kflows/publish-pages-with-writerside.yaml → .github/workflows/publish-pages.yaml b/...kflows/publish-pages-with-writerside.yaml → .github/workflows/publish-pages.yaml
@@ -5,32 +5,17 @@ on:
     branches: ["main"]
   workflow_dispatch:
 
-env:
-  INSTANCE: 'Writerside/doc'
-  ARTIFACT: 'webHelpDOC2-all.zip'
-  DOCKER_VERSION: '243.22562'
-
 jobs:
   build-docs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 #v4.1.7
         with:
           fetch-depth: 0
-
-      - uses: JetBrains/writerside-github-action@5a6920dbce3ef3169acbeb7e45c6cbdaf7e76bfa #v4
-        with:
-          instance: ${{ env.INSTANCE }}
-          artifact: ${{ env.ARTIFACT }}
-          docker-version: ${{ env.DOCKER_VERSION }}
-
       - uses: gradle/actions/setup-gradle@dbbdc275be76ac10734476cc723d82dfe7ec6eda #v3.4.2
       - run: |
           export JAVA_HOME=$JAVA_HOME_21_X64 # Remove when ubuntu-latest updates to Java 21
           ./gradlew librarianStaticContent
-          find Writerside
-          unzip artifacts/${{ env.ARTIFACT }} -d build/static
-
       - uses: JamesIves/github-pages-deploy-action@94f3c658273cf92fb48ef99e5fbc02bd2dc642b2 #v4.6.3
         with:
           branch: gh-pages # The branch the action should deploy to.

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2024 GradleUp developers
+Copyright (c) 2016-2025 GradleUp developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/Writerside/c.list b/Writerside/c.list
diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml
diff --git a/Writerside/doc.tree b/Writerside/doc.tree
diff --git a/Writerside/topics/cli.md b/Writerside/topics/cli.md
diff --git a/Writerside/topics/libraries.md b/Writerside/topics/libraries.md
diff --git a/Writerside/v.list b/Writerside/v.list
diff --git a/Writerside/writerside.cfg b/Writerside/writerside.cfg
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -12,3 +12,19 @@ buildscript {
 }
 
 Librarian.root(project)
+
+tasks.register("librarianBuildDocs", Exec::class.java) {
+  enabled = file("docs").exists()
+
+  commandLine("npm", "run", "build")
+  workingDir("docs")
+}
+
+tasks.named("librarianStaticContent").configure {
+  dependsOn("librarianBuildDocs")
+
+  val from = file("docs/dist")
+  doLast {
+    from.copyRecursively(outputs.files.single(), overwrite = true)
+  }
+}
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -2,26 +2,33 @@
 import { defineConfig } from 'astro/config';
 import starlight from '@astrojs/starlight';
 
-// https://astro.build/config
 export default defineConfig({
 	integrations: [
 		starlight({
-			title: 'My Docs',
+			title: 'Librarian',
+			editLink: {
+				baseUrl: 'https://github.com/GradleUp/librarian/edit/main/docs/',
+			},
+			logo: {
+				src: './src/assets/logo.svg'
+			},
 			social: {
-				github: 'https://github.com/withastro/starlight',
+				github: 'https://github.com/GradleUp/librarian',
 			},
 			sidebar: [
-				{
-					label: 'Guides',
-					items: [
-						// Each item here is one entry in the navigation menu.
-						{ label: 'Example Guide', slug: 'guides/example' },
-					],
-				},
-				{
-					label: 'Reference',
-					autogenerate: { directory: 'reference' },
-				},
+				{ label: 'Welcome', link: '/', },
+				{ label: 'CLI', link: '/cli' },
+				// {
+				// 	label: 'Guides',
+				// 	items: [
+				// 		// Each item here is one entry in the navigation menu.
+				// 		{ label: 'Example Guide', slug: 'guides/example' },
+				// 	],
+				// },
+				// {
+				// 	label: 'Reference',
+				// 	autogenerate: { directory: 'reference' },
+				// },
 			],
 		}),
 	],

diff --git a/docs/public/favicon.svg b/docs/public/favicon.svg
diff --git a/docs/src/assets/houston.webp b/docs/src/assets/houston.webp
diff --git a/docs/src/assets/logo.svg b/docs/src/assets/logo.svg
diff --git a/docs/src/content/docs/cli.mdx b/docs/src/content/docs/cli.mdx
@@ -0,0 +1,5 @@
+---
+title: CLI
+---
+
+# CLI
diff --git a/docs/src/content/docs/guides/example.md b/docs/src/content/docs/guides/example.md
diff --git a/Writerside/topics/welcome.md → docs/src/content/docs/index.md b/Writerside/topics/welcome.md → docs/src/content/docs/index.md
@@ -1,36 +1,40 @@
-# Welcome
+---
+title: Welcome to Librarian
+---
 
-Librarian is an opinionated toolkit to build Kotlin libraries. 
+Librarian is an opinionated toolkit to build Kotlin libraries.
 
-> This project is work in progress
-{style=info}
+:::note
+This project is work in progress
+
+:::
 
 Librarian:
 
 * publishes your KMP/Android/JVM libraries to:
-  * Maven Central using [default host](https://central.sonatype.org/publish/publish-guide/#releasing-to-central)
-  * Maven Central using [S01 host](https://central.sonatype.org/publish/publish-guide/#releasing-to-central)
-  * Maven Central using [the central portal API](https://central.sonatype.com/api-doc)
-  * OSS Sonatype snapshots using the default host
-  * OSS Sonatype snapshots using the S01 host
-  * [Google Cloud Storage](https://cloud.google.com/storage?hl=en)
-  * GitHub pages snapshots
-* generates versioned KDoc using [Dokka](https://github.com/Kotlin/dokka) 
+    * Maven Central using [default host](https://central.sonatype.org/publish/publish-guide/#releasing-to-central)
+    * Maven Central using [S01 host](https://central.sonatype.org/publish/publish-guide/#releasing-to-central)
+    * Maven Central using [the central portal API](https://central.sonatype.com/api-doc)
+    * OSS Sonatype snapshots using the default host
+    * OSS Sonatype snapshots using the S01 host
+    * [Google Cloud Storage](https://cloud.google.com/storage?hl=en)
+    * GitHub pages snapshots
+* generates versioned KDoc using [Dokka](https://github.com/Kotlin/dokka)
 * automates your workflows using GitHub actions:
-  * pull requests
-  * documentation
-  * SNAPSHOTs
-  * releases
+    * pull requests
+    * documentation
+    * SNAPSHOTs
+    * releases
 * generates a Kotlin property holding your library version
-* monitors your binary compatibility using Kotlin Binary Compatibility validator 
-* configures Java and Kotlin compatibility 
+* monitors your binary compatibility using Kotlin Binary Compatibility validator
+* configures Java and Kotlin compatibility
 * ensure your libs can be consumed with maven
 * manages your changelog
 * and more!
 
-This is a lot of things for a single tool, and a lot of opinions too! 
+This is a lot of things for a single tool, and a lot of opinions too!
 
-Because every lib is different and opinions may differ, Librarian is also shipped as low level libraries that you can use on a case by case basis. 
+Because every lib is different and opinions may differ, Librarian is also shipped as low level libraries that you can use on a case by case basis.
 
 Just want the publishing without the GitHub workflows, use `librarian-publishing`. Just want maven sympathy, use `librarian-maven-sympathy`, etc... For more information, read the [libraries page](libraries.md).
 

diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx
diff --git a/docs/src/content/docs/reference/example.md b/docs/src/content/docs/reference/example.md
diff --git a/graphics/logo.sketch b/graphics/logo.sketch