diff --git a/.github/workflows/Create-Astro-GhostCMS.yml b/.github/workflows/Create-Astro-GhostCMS.yml new file mode 100644 index 00000000..3c786675 --- /dev/null +++ b/.github/workflows/Create-Astro-GhostCMS.yml @@ -0,0 +1,52 @@ +name: Publish Create-Astro-GhostCMS + +on: + workflow_dispatch: + +jobs: + publishnpm: + runs-on: ubuntu-latest + defaults: + run: + working-directory: ./packages/create-astro-ghostcms + steps: + - name: checkout + uses: actions/checkout@v3 + - name: node + uses: actions/setup-node@v3 + with: + node-version: 18 + registry-url: https://registry.npmjs.org/ + - name: publish-npm + run: | + # Change publish registry + echo "$(jq '.publishConfig.registry = "https://registry.npmjs.org"' package.json)" > package.json + # Publish package + npm publish + env: + NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} + + githubpackage: + permissions: + contents: read + packages: write + runs-on: ubuntu-latest + defaults: + run: + working-directory: ./packages/create-astro-ghostcms + steps: + - name: checkout + uses: actions/checkout@v3 + - name: node + uses: actions/setup-node@v3 + with: + node-version: 18 + registry-url: https://npm.pkg.github.com + - name: publish-github + run: | + # Change publish registry + echo "$(jq '.publishConfig.registry = "https://npm.pkg.github.com"' package.json)" > package.json + # Publish package + npm publish + env: + NODE_AUTH_TOKEN: ${{secrets.ACTION_TOKEN}} diff --git a/README.md b/README.md index 15c8e704..92bc056f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,17 @@ # Welcome to Astro-GhostCMS +## Quick Start + +```sh +# Run this command and follow the prompt! +npx @matthiesenxyz/create-astro-ghostcms +# Want to pass arguments through to the command? YOU CAN! +# `--install` : Sets Install Dependencies to 'true' +# `--git` : Initiates git Repo +# `--pkg-manager` : Specify your Package manager(i.e. npm, yarn | DEFAULT: pnpm) +``` + For a full always up to date documentation please checkout [Our Website](https://astro-ghostcms.xyz) **Demo site Deploy status**: diff --git a/packages/create-astro-ghostcms/package.json b/packages/create-astro-ghostcms/package.json index 8de4ecb6..4328d1de 100644 --- a/packages/create-astro-ghostcms/package.json +++ b/packages/create-astro-ghostcms/package.json @@ -1,6 +1,6 @@ { "name": "@matthiesenxyz/create-astro-ghostcms", - "version": "0.0.1-dev42", + "version": "0.0.1", "description": "Utility to quickly get started with our Integration and astro", "type": "module", "main": "./create-astro-ghostcms.mjs", diff --git a/www/src/assets/quickstart.sh b/www/src/assets/quickstart.sh index 4d6d9be1..e2053b9b 100644 --- a/www/src/assets/quickstart.sh +++ b/www/src/assets/quickstart.sh @@ -1,9 +1,6 @@ -# First Create a fresh Astro Install -npm create astro@latest -# Create Empty Install with standard typescript -# Then Delete entire 'pages' folder under '/src/' -npx astro add @matthiesenxyz/astro-ghostcms -# Then Create the following environment variables in .env -# Tip: Set these to YOUR GhostCMS server to pull your content! -CONTENT_API_KEY=a33da3965a3a9fb2c6b3f63b48 -CONTENT_API_URL=https://ghostdemo.matthiesen.xyz \ No newline at end of file +# Run this command and follow the prompt! +npx @matthiesenxyz/create-astro-ghostcms +# Want to pass arguments through to the command? YOU CAN! +# `--install` : Sets Install Dependencies to 'true' +# `--git` : Initiates git Repo +# `--pkg-manager` : Specify your Package manager(i.e. npm, yarn | DEFAULT: pnpm) \ No newline at end of file diff --git a/www/src/content/docs/docs/introduction/integration/manual.md b/www/src/content/docs/docs/introduction/integration/manual.md index d6256db0..314e4e47 100644 --- a/www/src/content/docs/docs/introduction/integration/manual.md +++ b/www/src/content/docs/docs/introduction/integration/manual.md @@ -6,7 +6,16 @@ description: Integration Mode - Manual Install ## Install ```sh -npm i @matthiesenxyz/astro-ghostcms @matthiesenxyz/astro-ghostcms-theme-default +# For fresh Install +npm create astro@latest +# Create Empty Install with standard typescript +# Then Delete entire `pages` folder under `/src/` + +# Then run one of the following: +# Astro Quick mode +npx astro add @matthiesenxyz/astro-ghostcms +# Manual Method +npm i @matthiesenxyz/astro-ghostcms ``` Then set your `astro.config.ts` to look like this: diff --git a/www/src/content/docs/docs/introduction/integration/quick.md b/www/src/content/docs/docs/introduction/integration/quick.md index c0c57e20..ab962e75 100644 --- a/www/src/content/docs/docs/introduction/integration/quick.md +++ b/www/src/content/docs/docs/introduction/integration/quick.md @@ -3,24 +3,20 @@ title: Integration Mode - Quick Install description: Integration Mode - Quick Install --- -## Install - -```sh -# For fresh Install -npm create astro@latest -# Create Empty Install with standard typescript -# Then Delete entire `pages` folder under `/src/` -npx astro add @matthiesenxyz/astro-ghostcms +```sh title="Simple" +# Run this command and follow the prompt! +npx astro add @matthiesenxyz/create-astro-ghostcms +# Want to pass arguments through to the command? YOU CAN! +# `--install` : Sets Install Dependencies to 'true' +# `--git` : Initiates git Repo +# `--pkg-manager` : Specify your Package manager(i.e. npm, yarn | DEFAULT: pnpm) ``` -## Setup `.env` variables - -```ansi frame="code" title=".env" -CONTENT_API_KEY=a33da3965a3a9fb2c6b3f63b48 -CONTENT_API_URL=https://ghostdemo.matthiesen.xyz +```sh title="Advanced" +npx astro add @matthiesenxyz/create-astro-ghostcms