update

package.json

@@ -7,6 +7,7 @@
 	},
 	"scripts": {
 		"dev": "pnpm --filter playground dev",
+		"starlight:dev": "pnpm --filter starlight-playground dev",
 		"lint": "biome check .",
 		"lint:fix": "biome check --apply .",
 		"ci:version": "pnpm changeset version",

packages/starlight-ghostcms/index.ts

@@ -5,11 +5,11 @@ import { vitePluginStarlightGhostConfig } from './src/integrations/vite'
 
 export type { StarlightGhostConfig }
 
-export default function starlightBlogPlugin(userConfig?: StarlightGhostConfig): StarlightPlugin {
+export default function starlightGhostCMS(userConfig?: StarlightGhostConfig): StarlightPlugin {
     const config: StarlightGhostConfig = validateConfig(userConfig)
     
     return {
-      name: 'starlight-blog-plugin',
+      name: 'starlight-ghostcms-plugin',
       hooks: {
         setup({ addIntegration, config: starlightConfig, logger, updateConfig: updateStarlightConfig }) {
             updateStarlightConfig({
@@ -58,12 +58,12 @@ function overrideStarlightComponent(
   ) {
     if (components?.[component]) {
       logger.warn(`It looks like you already have a \`${component}\` component override in your Starlight configuration.`)
-      logger.warn(`To use \`starlight-blog\`, remove the override for the \`${component}\` component.\n`)
+      logger.warn(`To use \`starlight-ghostcms\`, remove the override for the \`${component}\` component.\n`)
   
       return {}
     }
   
     return {
-      [component]: `starlight-blog/overrides/${component}.astro`,
+      [component]: `@matthiesenxyz/starlight-ghostcms/overrides/${component}.astro`,
     }
   }

packages/starlight-ghostcms/package.json

@@ -17,9 +17,10 @@
   "keywords": [
     "starlight",
     "starlight-plugin",
+    "astro",
+    "plugin",
     "blog",
     "content",
-    "integration",
     "ghost",
     "ghostcms"
   ],

packages/starlight-ghostcms/src/utils/api/api-functions.ts

@@ -3,7 +3,7 @@ import type { Page, Post } from "./content-api/schemas";
 import type { ContentAPICredentials } from './content-api/content-api'
 // LOAD ENVIRONMENT VARIABLES
 import { loadEnv } from "vite";
-import { invariant } from "./invariant";
+import { invariant } from "./invariant.js";
 
 const { CONTENT_API_KEY, CONTENT_API_URL } = loadEnv(
 	"all",

pnpm-workspace.yaml

@@ -1,3 +1,4 @@
 packages:
   - "packages/*"
-  - "playground"
+  - "playground"
+  - "starlight-playground"

starlight-playground/.gitignore

@@ -0,0 +1,21 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store

starlight-playground/.vscode/extensions.json

@@ -0,0 +1,4 @@
+{
+    "recommendations": ["astro-build.astro-vscode"],
+    "unwantedRecommendations": []
+}

starlight-playground/.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "command": "./node_modules/.bin/astro dev",
+        "name": "Development server",
+        "request": "launch",
+        "type": "node-terminal"
+      }
+    ]
+}

starlight-playground/astro.config.mjs

@@ -0,0 +1,29 @@
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+import starlightGhostCMS from '@matthiesenxyz/starlight-ghostcms';
+
+// https://astro.build/config
+export default defineConfig({
+	integrations: [
+		starlight({
+			title: 'My Docs',
+			plugins: [starlightGhostCMS()],
+			social: {
+				github: 'https://github.com/withastro/starlight',
+			},
+			sidebar: [
+				{
+					label: 'Guides',
+					items: [
+						// Each item here is one entry in the navigation menu.
+						{ label: 'Example Guide', link: '/guides/example/' },
+					],
+				},
+				{
+					label: 'Reference',
+					autogenerate: { directory: 'reference' },
+				},
+			],
+		}),
+	],
+});

starlight-playground/package.json

@@ -0,0 +1,20 @@
+{
+    "name": "starlight-playground",
+    "type": "module",
+    "version": "0.0.1",
+    "private": true,
+    "sideEffects": false,
+    "scripts": {
+      "dev": "astro dev",
+      "start": "astro dev",
+      "build": "astro build",
+      "preview": "astro preview",
+      "astro": "astro"
+    },
+    "dependencies": {
+      "@astrojs/starlight": "^0.19.0",
+      "@matthiesenxyz/starlight-ghostcms": "workspace:*",
+      "astro": "^4.3.7",
+      "sharp": "^0.32.5"
+    }
+  }

starlight-playground/public/favicon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><path fill-rule="evenodd" d="M81 36 64 0 47 36l-1 2-9-10a6 6 0 0 0-9 9l10 10h-2L0 64l36 17h2L28 91a6 6 0 1 0 9 9l9-10 1 2 17 36 17-36v-2l9 10a6 6 0 1 0 9-9l-9-9 2-1 36-17-36-17-2-1 9-9a6 6 0 1 0-9-9l-9 10v-2Zm-17 2-2 5c-4 8-11 15-19 19l-5 2 5 2c8 4 15 11 19 19l2 5 2-5c4-8 11-15 19-19l5-2-5-2c-8-4-15-11-19-19l-2-5Z" clip-rule="evenodd"/><path d="M118 19a6 6 0 0 0-9-9l-3 3a6 6 0 1 0 9 9l3-3Zm-96 4c-2 2-6 2-9 0l-3-3a6 6 0 1 1 9-9l3 3c3 2 3 6 0 9Zm0 82c-2-2-6-2-9 0l-3 3a6 6 0 1 0 9 9l3-3c3-2 3-6 0-9Zm96 4a6 6 0 0 1-9 9l-3-3a6 6 0 1 1 9-9l3 3Z"/><style>path{fill:#000}@media (prefers-color-scheme:dark){path{fill:#fff}}</style></svg>

starlight-playground/src/content/config.ts

@@ -0,0 +1,6 @@
+import { defineCollection } from 'astro:content';
+import { docsSchema } from '@astrojs/starlight/schema';
+
+export const collections = {
+	docs: defineCollection({ schema: docsSchema() }),
+};

starlight-playground/src/content/docs/guides/example.md

@@ -0,0 +1,11 @@
+---
+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

starlight-playground/src/content/docs/index.mdx

@@ -0,0 +1,36 @@
+---
+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
+      variant: primary
+    - text: Read the Starlight docs
+      link: https://starlight.astro.build
+      icon: external
+---
+
+import { Card, CardGrid } from '@astrojs/starlight/components';
+
+## Next steps
+
+<CardGrid stagger>
+	<Card title="Update content" icon="pencil">
+		Edit `src/content/docs/index.mdx` to see this page change.
+	</Card>
+	<Card title="Add new content" icon="add-document">
+		Add Markdown or MDX files to `src/content/docs` to create new pages.
+	</Card>
+	<Card title="Configure your site" icon="setting">
+		Edit your `sidebar` and other config in `astro.config.mjs`.
+	</Card>
+	<Card title="Read the docs" icon="open-book">
+		Learn more in [the Starlight Docs](https://starlight.astro.build/).
+	</Card>
+</CardGrid>

starlight-playground/src/content/docs/reference/example.md

@@ -0,0 +1,11 @@
+---
+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

starlight-playground/src/env.d.ts

@@ -0,0 +1,2 @@
+/// <reference path="../.astro/types.d.ts" />
+/// <reference types="astro/client" />

starlight-playground/tsconfig.json

@@ -0,0 +1,3 @@
+{
+    "extends": "astro/tsconfigs/strict"
+}