-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f8410d2
commit d4a22d2
Showing
2 changed files
with
75 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,69 @@ | ||
# Jamstack CMS astro plugin | ||
# Astro plugin | ||
|
||
![npm](https://img.shields.io/npm/v/%40lucarickli%2Fjamstack-cms-astro) | ||
![size](https://img.shields.io/bundlejs/size/%40lucarickli%2Fjamstack-cms-astro) | ||
|
||
Astro plugin to easily integrate jamstack-cms into your website. | ||
|
||
## Install | ||
|
||
```sh | ||
npm i --save @lucarickli/jamstack-cms-astro | ||
``` | ||
|
||
**File** `astro.config.mjs` | ||
|
||
```js | ||
import { defineConfig } from "astro/config"; | ||
import { jamstackCmsPlugin } from "@lucarickli/jamstack-cms-astro"; | ||
import sitemap from "@astrojs/sitemap"; | ||
|
||
export default defineConfig({ | ||
site: "https://example.com", | ||
integrations: [ | ||
sitemap(), | ||
jamstackCmsPlugin({ | ||
backend: { | ||
... | ||
}, | ||
collections: [ | ||
... | ||
], | ||
}), | ||
], | ||
}); | ||
``` | ||
|
||
## Commands | ||
|
||
### Dev | ||
|
||
```sh | ||
npm run dev | ||
``` | ||
|
||
### Dev + debug | ||
|
||
```sh | ||
npm run dev:debug | ||
``` | ||
|
||
### Build | ||
|
||
```sh | ||
npm run build | ||
``` | ||
|
||
### Start | ||
|
||
> This requires a build of the app! | ||
```sh | ||
npm run start | ||
``` | ||
|
||
### Run checks | ||
|
||
```sh | ||
npm run check | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -41,3 +41,9 @@ npm run build | |
```sh | ||
npm run start | ||
``` | ||
|
||
### Run checks | ||
|
||
```sh | ||
npm run check | ||
``` |