diff --git a/.github/workflows/publish-pages-with-writerside.yaml b/.github/workflows/publish-pages.yaml similarity index 63% rename from .github/workflows/publish-pages-with-writerside.yaml rename to .github/workflows/publish-pages.yaml index ec9ca62..291a9a8 100644 --- a/.github/workflows/publish-pages-with-writerside.yaml +++ b/.github/workflows/publish-pages.yaml @@ -5,11 +5,6 @@ on: branches: ["main"] workflow_dispatch: -env: - INSTANCE: 'Writerside/doc' - ARTIFACT: 'webHelpDOC2-all.zip' - DOCKER_VERSION: '243.22562' - jobs: build-docs: runs-on: ubuntu-latest @@ -17,20 +12,10 @@ jobs: - 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 index cff0609..184efe5 100644 --- 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 deleted file mode 100644 index c4c77a2..0000000 --- a/Writerside/c.list +++ /dev/null @@ -1,6 +0,0 @@ - - - - - \ No newline at end of file diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml deleted file mode 100644 index c2509dd..0000000 --- a/Writerside/cfg/buildprofiles.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - true - GitHub - https://github.com/GradleUp/librarian/ - true - true - https://github.com/GradleUp/librarian/edit/main/Writerside/ - - - diff --git a/Writerside/doc.tree b/Writerside/doc.tree deleted file mode 100644 index f106f6b..0000000 --- a/Writerside/doc.tree +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - \ No newline at end of file diff --git a/Writerside/topics/cli.md b/Writerside/topics/cli.md deleted file mode 100644 index db3cc67..0000000 --- a/Writerside/topics/cli.md +++ /dev/null @@ -1 +0,0 @@ -# CLI \ No newline at end of file diff --git a/Writerside/topics/libraries.md b/Writerside/topics/libraries.md deleted file mode 100644 index 3290d70..0000000 --- a/Writerside/topics/libraries.md +++ /dev/null @@ -1 +0,0 @@ -# Libraries diff --git a/Writerside/v.list b/Writerside/v.list deleted file mode 100644 index 7b3b8cb..0000000 --- a/Writerside/v.list +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/Writerside/writerside.cfg b/Writerside/writerside.cfg deleted file mode 100644 index c8dbe1a..0000000 --- a/Writerside/writerside.cfg +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts index 99cd484..830908f 100644 --- 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) + } +} \ No newline at end of file diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 1b39364..ffbc6e9 100644 --- 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 index cba5ac1..2da5f75 100644 --- a/docs/public/favicon.svg +++ b/docs/public/favicon.svg @@ -1 +1,15 @@ - \ No newline at end of file + + + Slice + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/src/assets/houston.webp b/docs/src/assets/houston.webp deleted file mode 100644 index 930c164..0000000 Binary files a/docs/src/assets/houston.webp and /dev/null differ diff --git a/docs/src/assets/logo.svg b/docs/src/assets/logo.svg new file mode 100644 index 0000000..2da5f75 --- /dev/null +++ b/docs/src/assets/logo.svg @@ -0,0 +1,15 @@ + + + Slice + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/src/content/docs/cli.mdx b/docs/src/content/docs/cli.mdx new file mode 100644 index 0000000..5ec6465 --- /dev/null +++ b/docs/src/content/docs/cli.mdx @@ -0,0 +1,5 @@ +--- +title: CLI +--- + +# CLI \ No newline at end of file diff --git a/docs/src/content/docs/guides/example.md b/docs/src/content/docs/guides/example.md deleted file mode 100644 index ebd0f3b..0000000 --- a/docs/src/content/docs/guides/example.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Example Guide -description: A guide in my new Starlight docs site. ---- - -Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. -Writing a good guide requires thinking about what your users are trying to do. - -## Further reading - -- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework diff --git a/Writerside/topics/welcome.md b/docs/src/content/docs/index.md similarity index 73% rename from Writerside/topics/welcome.md rename to docs/src/content/docs/index.md index f64e023..7de66b6 100644 --- a/Writerside/topics/welcome.md +++ b/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 deleted file mode 100644 index 664b681..0000000 --- a/docs/src/content/docs/index.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Welcome to Starlight -description: Get started building your docs site with Starlight. -template: splash -hero: - tagline: Congrats on setting up a new Starlight project! - image: - file: ../../assets/houston.webp - actions: - - text: Example Guide - link: /guides/example/ - icon: right-arrow - - text: Read the Starlight docs - link: https://starlight.astro.build - icon: external - variant: minimal ---- - -import { Card, CardGrid } from '@astrojs/starlight/components'; - -## Next steps - - - - Edit `src/content/docs/index.mdx` to see this page change. - - - Add Markdown or MDX files to `src/content/docs` to create new pages. - - - Edit your `sidebar` and other config in `astro.config.mjs`. - - - Learn more in [the Starlight Docs](https://starlight.astro.build/). - - diff --git a/docs/src/content/docs/reference/example.md b/docs/src/content/docs/reference/example.md deleted file mode 100644 index 0224f09..0000000 --- a/docs/src/content/docs/reference/example.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Example Reference -description: A reference page in my new Starlight docs site. ---- - -Reference pages are ideal for outlining how things work in terse and clear terms. -Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting. - -## Further reading - -- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework diff --git a/graphics/logo.sketch b/graphics/logo.sketch new file mode 100644 index 0000000..4242bf3 Binary files /dev/null and b/graphics/logo.sketch differ