Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stackbit/sourcebit-source-sanity
A Sanity source plugin for Sourcebit
https://github.com/stackbit/sourcebit-source-sanity
Last synced: about 1 month ago
JSON representation
A Sanity source plugin for Sourcebit
- Host: GitHub
- URL: https://github.com/stackbit/sourcebit-source-sanity
- Owner: stackbit
- License: mit
- Created: 2020-01-30T15:09:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T14:16:11.000Z (over 1 year ago)
- Last Synced: 2024-04-24T04:11:35.558Z (7 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/sourcebit-source-sanity
- Size: 1.04 MB
- Stars: 4
- Watchers: 3
- Forks: 5
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sourcebit-source-sanity
[](https://coveralls.io/github/stackbithq/sourcebit-source-sanity)
[](https://badge.fury.io/js/sourcebit-source-sanity)
> A [Sanity](https://www.sanity.io) source plugin for [Sourcebit](https://github.com/stackbithq/sourcebit)
## 👩🏫 Introduction
With this plugin, you can add Sanity as a data source for Sourcebit. To connect your Sanity account, you need an [API token](https://www.sanity.io/docs/http-auth), your project ID and the name of your [dataset](https://www.sanity.io/docs/datasets).
## 🏗 Installation
To install the plugin and add it to your project, run:
```
npm install sourcebit-source-sanity --save
```
> 💡 You don't need to run this command if you start Sourcebit using the [interactive setup process](#%EF%B8%8F-interactive-setup-process), as the CLI will install the plugin for you and add it as a dependency to your project.
## ⚙️ Configuration
The plugin accepts the following configuration parameters. They can be supplied in any of the following ways:
- In the `options` object of the plugin configuration block inside `sourcebit.js`, with the value of the _Property_ column as a key;
- As an environment variable named after the _Env variable_ column, when running the `sourcebit fetch` command;
- As part of a `.env` file, with the value of the _Env variable_ column separated by the value with an equals sign (e.g. `MY_VARIABLE=my-value`);
- As a CLI parameter, when running the `sourcebit fetch` command, using the value of the _Parameter_ column as the name of the parameter (e.g. `sourcebit fetch --my-parameter`).
| Property | Type | Visibility | Default value | Env variable | Parameter | Description |
| ---------------------- | ------- | ----------- | ------------- | --------------------- | --------- | ------------------------------------------------------------------------------------------ |
| `accessToken` | String | **Private** | | `SANITY_ACCESS_TOKEN` | | The Sanity API token. |
| `dataset` | String | Public | | | | The name of the [dataset](https://www.sanity.io/docs/datasets). |
| `isPreview` | Boolean | Public | `false` | | | Whether to include draft/unpublished entries. |
| `query` | String | Public | `"*[]"` | | | The query to pass to the Sanity API. |
| `queryParameters` | Object | Public | `{}` | | | The query parameters to pass to the Sanity API. |
| `projectId` | String | Public | | | | The ID of the Sanity project. |
| `richTextOutputFormat` | String | Public | `html` | | | The format to convert rich-text fields to. Accepted values: `html`, `markdown` and `none`. |
| `useCdn` | Boolean | Public | `false` | | | Whether to use the [Data API CDN](https://www.sanity.io/docs/api-cdn). |
| `watch` | Boolean | Public | | | `watch` | Whether to poll Sanity for content changes. |
### 👀 Example configuration
_sourcebit.js_
```js
module.exports = {
plugins: [
{
module: require('sourcebit-source-sanity'),
options: {
accessToken: process.env['SANITY_ACCESS_TOKEN'],
dataset: 'production',
projectId: '1q2w3e4r'
}
}
]
};
```
_.env_
```
SANITY_ACCESS_TOKEN=123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ
```
### 🧞♂️ Interactive setup process
This plugin offers an interactive setup process via the `npx create-sourcebit` command.
## 📥 Input
_N/A_
## 📤 Output
This plugin adds normalized entries to the `objects` data bucket.