Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
LucaRickli committed May 25, 2024
1 parent f8410d2 commit d4a22d2
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 1 deletion.
70 changes: 69 additions & 1 deletion astro-plugin/README.md
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
```
6 changes: 6 additions & 0 deletions github-oauth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,9 @@ npm run build
```sh
npm run start
```

### Run checks

```sh
npm run check
```

0 comments on commit d4a22d2

Please sign in to comment.