2024-01-31 09:26:55 +00:00
< img src = "https://repository-images.githubusercontent.com/742727289/d4fb3f65-0d5f-4a1a-9f8b-9b3e2dc90bde" / >
2024-01-13 07:20:44 +00:00
2024-01-29 11:42:24 +00:00
Want to Chat? Join our [Discord ](https://discord.gg/u7NZqUyeAR )
2024-01-31 09:26:55 +00:00
For a full always up to date documentation please checkout [Our Website ](https://astro-ghostcms.xyz )
2024-02-12 15:01:56 +00:00
## Demos
2024-02-12 15:03:24 +00:00
- [Default Theme ](https://demo.astro-ghostcms.xyz ) - ( [Github Repo ](https://github.com/MatthiesenXYZ/demo-astroghostcms-themedefault ) )
- [Catppuccin Theme ](https://catppuccindark-demo.astro-ghostcms.xyz/ ) - ( [Github Repo ](https://github.com/MatthiesenXYZ/demo-astroghostcms-catppuccin ) )
- [Brutal by Elian Theme ](https://brutal-demo.astro-ghostcms.xyz ) - ( [Github Repo ](https://github.com/MatthiesenXYZ/demo-astroghostcms-brutalbyelian ) )
2024-01-31 22:55:25 +00:00
2024-01-28 10:00:50 +00:00
## Quick Start
```sh
2024-01-31 09:26:55 +00:00
# Its easy run this command and follow the prompt!
2024-01-28 10:00:50 +00:00
npx @matthiesenxyz/create -astro-ghostcms
```
2024-01-31 09:26:55 +00:00
## Our Supporters:
2024-01-17 10:01:04 +00:00
2024-01-31 09:26:55 +00:00
Want to be listed here? by name or logo? [Signup Here ](https://www.buymeacoffee.com/adammatthiesen/membership ) for an Astro-GhostCMS Suppoter Membership *(Silver and up get listed here)* Also All Suppoter Memberships get a Discord rank!
2024-01-17 10:18:57 +00:00
2024-01-23 20:56:52 +00:00
## Repo Structure
2024-01-17 10:01:04 +00:00
2024-01-31 09:26:55 +00:00
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 ](https://npmjs.com )
2024-01-17 10:01:04 +00:00
2024-01-31 09:26:55 +00:00
In this Repo you will find the Following:
2024-01-24 02:17:54 +00:00
- `playground` : Development and Testing
- `packages/` :
2024-01-28 04:27:23 +00:00
- `create-astro-ghostcms` : CLI Utility to quickly deploy new Astro-GhostCMS projects.
2024-01-24 02:17:54 +00:00
- `astro-ghostcms` : The main Integration!
2024-02-13 10:40:30 +00:00
- `astro-ghostcms-rendercontent` : Allows rendering of remote GhostCMS HTML with Custom Astro Components
2024-01-27 20:44:19 +00:00
- `astro-ghostcms-theme-default` : The Default theme in integration mode.
2024-02-01 22:47:04 +00:00
- `astro-ghostcms-catppuccin` : A dark theme made with Catppuccin and TailwindCSS for Astro-GhostCMS Integration Mode.
2024-02-11 04:47:16 +00:00
- `astro-ghostcms-brutalbyelian` : [ElianCodes ](https://www.elian.codes/ ) Brutal theme modified to work with Astro-GhostCMS
2024-01-27 20:44:19 +00:00
- `tsconfig` : *LOCAL* Development package for `@ts-ghost/core-api` .
2024-01-17 10:01:04 +00:00
2024-01-29 10:50:26 +00:00
## Contributing
This is a `pnpm` workspace and requires `pnpm` to function properly
To setup this workspace clone this repo and run the following command:
```sh
pnpm install
```
Then you can run the playground:
```sh
pnpm playground:dev
```
2024-02-14 06:50:50 +00:00
### Acknolegments
2024-01-22 11:45:15 +00:00
2024-01-23 20:56:52 +00:00
*Ghost is a trademark of [The Ghost Foundation ](https://ghost.org/trademark/ ). 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.*
2024-02-13 16:12:31 +00:00
2024-02-14 06:50:50 +00:00
[![Built with Astro ](https://astro.badg.es/v2/built-with-astro/medium.svg )](https://astro.build)
Maintained with [GitKraken ](https://www.gitkraken.com/invite/hirocQWn )
< img width = "300" alt = "gitkraken-logo-stencil-color" src = "https://github.com/MatthiesenXYZ/astro-ghostcms/assets/30383579/751e20a9-8f7e-4a74-9fec-665e17f8715a" >