astro-ghostcms/README.md

Want to Chat? Join our Discord

For a full always up to date documentation please checkout Our Website

Don't like GitHub, and prefer GitLab? This Repo is Auto Cloned to Gitlab! Check it out here: GitLab: Astro-GhostCMS

Demos

• Default Theme - ( Github Repo )
• Catppuccin Theme - ( Github Repo )
• Brutal by Elian Theme - ( Github Repo )

Quick Start

# Its easy run this command and follow the prompt!
npx @matthiesenxyz/create-astro-ghostcms

Our Supporters:

Want to be listed here? by name or logo? Signup Here for an Astro-GhostCMS Suppoter Membership (Silver and up get listed here) Also All Suppoter Memberships get a Discord rank!

Repo Structure

This repo is structured as a pnpm monorepo. All of our packages can be found under the packages/ folder. These are all internal packages or independently published that can be found on npmjs.com

In this Repo you will find the Following:

• playground: Development and Testing
• packages/:
  • create-astro-ghostcms: CLI Utility to quickly deploy new Astro-GhostCMS projects.
  • astro-ghostcms: The main Integration!
  • astro-ghostcms-rendercontent: Allows rendering of remote GhostCMS HTML with Custom Astro Components
  • astro-ghostcms-theme-default: The Default theme in integration mode.
  • astro-ghostcms-catppuccin: A dark theme made with Catppuccin and TailwindCSS for Astro-GhostCMS Integration Mode.
  • astro-ghostcms-brutalbyelian: ElianCodes Brutal theme modified to work with Astro-GhostCMS
  • tsconfig: LOCAL Development package for @ts-ghost/core-api.

Contributing

This is a pnpm workspace and requires pnpm to function properly

To setup this workspace clone this repo and run the following command:

pnpm install --frozen-lockfile

Then you can run the playground:

pnpm playground:dev

Acknolegments

Ghost is a trademark of The Ghost Foundation. This project is 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.

Maintained with GitKraken