+
+# Welcome to Starlight-GhostCMS by [Astro-GhostCMS](https://astro-ghostcms.xyz)
+
+Starlight-GhostCMS is a [Starlight](https://starlight.astro.build/) plugin to add a blog to your documentation site.
+
+- Customizable Header link *(Defaults to "Blog")*
+- Pulls all the Posts from your GhostCMS install
+- Pulls all Authors & Featured Images and adds then to your Posts
+- Creates a custom section on your website linkable from the Header
+
+For a full always up to date documentation please checkout [Our Website](https://astro-ghostcms.xyz)
+
+- [Starlight Demo **COMING SOON**](#)
+- [Astro-GhostCMS Website](https://astro-ghostcms.xyz) Check the website for the most up-to-date Documentation!
+- [Ghost.org](https://ghost.org) Get your own Ghost[^1] Install
+
+*Need help but don't have Github? Email us at [issues@astro-ghostcms.xyz](mailto:issues@astroghostcms.xyz) to create an issue here on github! Or join our [Discord](https://discord.gg/u7NZqUyeAR)*
+
+Astro minimum Version: **Starlight v0.19 & Astro v4**
+
+## Installation
+
+### Prerequisites:
+
+1. You will need to have a Starlight Website Setup. If you dont have one yet, you can follow the ["Getting Started"](https://starlight.astro.build/getting-started) guide in the Starlight docs to create one.
+2. You will need a GhostCMS server, and your `CONTENT_API_KEY` & `CONTENT_API_URL`. Your GhostCMS server must also support the `v5` Version of the GhostAPI. If you dont already have your Key and Url, you can find out how to get those on the Ghost docs [HERE](https://ghost.org/docs/content-api/)
+
+### Install the plugin
+
+Starlight GhostCMS is a Starlight [plugin](https://starlight.astro.build/reference/plugins/). Install it using your favorite package manager. Below is 3 examples of what to run. **CHOOSE ONE**.
+
+```
+npm install @matthiesenxyz/starlight-ghostcms
+pnpm add @matthiesenxyz/starlight-ghostcms
+yarn add @matthiesenxyz/starlight-ghostcms
+```
+
+### Configure the pluign
+
+The Starlight GhostCMS plugin can be configured in your Starlight [configuration](https://starlight.astro.build/reference/configuration/#plugins) in the `astro.config.mjs` file.
+
+```ts
+import starlight from '@astrojs/starlight'
+import { defineConfig } from 'astro/config'
+import starlightGhostCMS from '@matthiesenxyz/starlight-ghostcms';
+
+export default defineConfig({
+ integrations: [
+ starlight({
+ plugins: [starlightGhostCMS()],
+ title: 'My Docs',
+ }),
+ ],
+})
+```
+
+### Set your GhostCMS ENV Variables
+
+You must also create 2 environment variables in a `.env` file with the following:
+
+```env
+CONTENT_API_KEY=a33da3965a3a9fb2c6b3f63b48
+CONTENT_API_URL=https://ghostdemo.matthiesen.xyz
+```
+
+**When you deploy your install dont forget to set the above ENVIRONMENT VARIABLES on your provider!**
+
+
+For more information and to see the docs please check our website: [Astro-GhostCMS.xyz](https://astro-ghostcms.xyz)
+
+# Foot Notes & Credits
+
+[^1]: Ghost.org, Ghost.io, Ghost are all trademarks of [The Ghost Foundation](https://ghost.org/). This project is Open Source and not directly related to or provided by The Ghost Foundation and is intended to help create a easier method to utilize their provided JavaScript tools to link a Headless GhostCMS install in to your Astro project.
+
diff --git a/packages/starlight-ghostcms/index.ts b/packages/starlight-ghostcms/index.ts
new file mode 100644
index 00000000..10d7d42a
--- /dev/null
+++ b/packages/starlight-ghostcms/index.ts
@@ -0,0 +1,66 @@
+import type { StarlightPlugin, StarlightUserConfig } from '@astrojs/starlight/types'
+import type { AstroIntegrationLogger } from 'astro'
+import { type StarlightGhostConfig, validateConfig } from './src/schemas/config'
+import { vitePluginStarlightGhostConfig } from './src/integrations/vite'
+
+export type { StarlightGhostConfig }
+
+export default function starlightGhostCMS(userConfig?: StarlightGhostConfig): StarlightPlugin {
+ const config: StarlightGhostConfig = validateConfig(userConfig)
+
+ return {
+ name: '@matthiesenxyz/starlight-ghostcms-plugin',
+ hooks: {
+ setup({ addIntegration, config: starlightConfig, logger, updateConfig: updateStarlightConfig }) {
+ updateStarlightConfig({
+ components: {
+ ...starlightConfig.components,
+ ...overrideStarlightComponent(starlightConfig.components, logger, 'MarkdownContent'),
+ ...overrideStarlightComponent(starlightConfig.components, logger, 'Sidebar'),
+ ...overrideStarlightComponent(starlightConfig.components, logger, "SiteTitle"),
+ }
+ })
+
+ addIntegration({
+ name: '@matthiesenxyz/starlight-ghostcms',
+ hooks: {
+ 'astro:config:setup': ({ injectRoute, updateConfig }) => {
+ injectRoute({
+ pattern: '/blog',
+ entrypoint: '@matthiesenxyz/starlight-ghostcms/routes/index.astro'
+ })
+ injectRoute({
+ pattern: '/blog/[slug]',
+ entrypoint: '@matthiesenxyz/starlight-ghostcms/routes/[slug].astro'
+ })
+
+ updateConfig({
+ vite: {
+ plugins: [vitePluginStarlightGhostConfig(config)],
+ },
+ })
+ }
+ }
+ })
+ }
+ },
+ }
+}
+
+function overrideStarlightComponent(
+ components: StarlightUserConfig['components'],
+ logger: AstroIntegrationLogger,
+ component: keyof NonNullable+ {entry.title} +
+
+ {typeof Excerpt === 'string' ? Excerpt : entry.excerpt}
+
+{author.name}
+ {author.bio && {author.bio}
}
+
+
+
+ {entries.map((entry) =>
+
+
diff --git a/packages/starlight-ghostcms/src/components/Preview.astro b/packages/starlight-ghostcms/src/components/Preview.astro
new file mode 100644
index 00000000..dcd5be13
--- /dev/null
+++ b/packages/starlight-ghostcms/src/components/Preview.astro
@@ -0,0 +1,40 @@
+---
+import type { Post } from '../schemas/posts'
+import Metadata from './Metadata.astro'
+
+interface Props {
+ entry: Post
+}
+
+const { entry } = Astro.props
+
+const Excerpt = entry.excerpt
+---
+
+
+ Blog
+
+ )
+}
+
+ {config.title}
+
+
+
\ No newline at end of file
diff --git a/packages/starlight-ghostcms/src/routes/[slug].astro b/packages/starlight-ghostcms/src/routes/[slug].astro
new file mode 100644
index 00000000..6ae03dd2
--- /dev/null
+++ b/packages/starlight-ghostcms/src/routes/[slug].astro
@@ -0,0 +1,60 @@
+---
+import config from 'virtual:starlight-ghost-config'
+import { Image } from "astro:assets";
+import Page from '../components/Page.astro'
+import { getPageProps } from '../utils/page'
+import { getAllPosts } from '../utils/api'
+import Metadata from '../components/Metadata.astro'
+
+
+export async function getStaticPaths() {
+ const entries = await getAllPosts();
+ return entries.map((post) => ({
+ params: { slug: post.slug },
+ props: { post, slug:post.slug },
+ }));
+}
+
+const { post } = Astro.props
+const pageProps = getPageProps(post.title)
+---
+
+Powered by Ghost
+ )}
+
+ +
Powered by Ghost
+ )}
+