27a717ad0f
Expanded Keystatic's configuration to support different storage kinds: local, cloud, and GitHub. Updated the README to explain the new configuration options, environment variables needed, and how to use storage kinds. Added external reference to Keystatic documentation for detailed concepts.
35 lines
954 B
Markdown
35 lines
954 B
Markdown
# CMS/Keystatic - @kit/keystatic
|
|
|
|
Implementation of the CMS layer using the Keystatic library.
|
|
|
|
This implementation is used when the host app's environment variable is set as:
|
|
|
|
```
|
|
CMS_CLIENT=keystatic
|
|
KEYSTATIC_PATH=content
|
|
```
|
|
|
|
Additionally, the following environment variables may be required:
|
|
|
|
```
|
|
KEYSTATIC_PATH=local # local, cloud, github
|
|
```
|
|
|
|
You can also use Keystatic Cloud or GitHub as the storage kind as remote storage.
|
|
|
|
If `KEYSTATIC_PATH_STORAGE_KIND` is set to `cloud`, the following environment variables are required:
|
|
|
|
```
|
|
KEYSTATIC_PATH_STORAGE_PROJECT=project-id
|
|
```
|
|
|
|
If `KEYSTATIC_PATH_STORAGE_KIND` is set to `github`, the following environment variables are required:
|
|
|
|
```
|
|
KEYSTATIC_PATH_STORAGE_REPO=repo-name
|
|
KEYSTATIC_PATH_STORAGE_BRANCH_PREFIX=branch-prefix
|
|
```
|
|
|
|
GitHub mode requires the installation of a GitHub app.
|
|
|
|
Please refer to the [Keystatic documentation](https://keystatic.com/docs/github-model) for more information. |