diff --git a/.changeset/config.json b/.changeset/config.json index 1013eb6d..db35bc78 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -7,5 +7,5 @@ "access": "public", "baseBranch": "main", "updateInternalDependencies": "patch", - "ignore": ["playground"] + "ignore": ["playground","starlight-playground"] } diff --git a/.changeset/six-mice-build.md b/.changeset/six-mice-build.md new file mode 100644 index 00000000..a3f3813d --- /dev/null +++ b/.changeset/six-mice-build.md @@ -0,0 +1,5 @@ +--- +"@matthiesenxyz/starlight-ghostcms": patch +--- + +Initial Public Release, Added Readme, Basics Working, Ready Set GO! diff --git a/packages/starlight-ghostcms/README.md b/packages/starlight-ghostcms/README.md new file mode 100644 index 00000000..7f2fa88a --- /dev/null +++ b/packages/starlight-ghostcms/README.md @@ -0,0 +1,75 @@ + + +# 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/package.json b/packages/starlight-ghostcms/package.json index 2ce56d3d..6106933f 100644 --- a/packages/starlight-ghostcms/package.json +++ b/packages/starlight-ghostcms/package.json @@ -1,7 +1,7 @@ { "name": "@matthiesenxyz/starlight-ghostcms", "description": "Starlight GhostCMS plugin to allow easier importing of GhostCMS Content into your starlight website", - "version": "0.0.1-dev01", + "version": "0.0.1", "homepage": "https://astro-ghostcms.xyz/", "type": "module", "license": "MIT",