https://github.com/brob/eleventy-plugin-sanity-data

https://github.com/brob/eleventy-plugin-sanity-data

Last synced: 25 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/brob/eleventy-plugin-sanity-data
• Owner: brob
• Created: 2021-03-05T01:56:27.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T11:38:05.000Z (about 1 year ago)
• Last Synced: 2024-11-07T00:30:34.331Z (2 months ago)
• Language: JavaScript
• Size: 196 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 11ty Sanity Data Source

*This currently only works in 11ty v1.0.0 (canary). It uses [addGlobalData](https://www.11ty.dev/docs/data-global-custom/) which allows for data plugins like this*

## Installation

Install the NPM package

```sh

npm install eleventy-plugin-sanity-data

```

Add the plugin to your .eleventy.js config file. *Make sure you're running Eleventy v1.0.0+*

```js

module.exports = function(config) {

    config.addPlugin(sanityData, {

        projectId: 'YOUR_SANITY_PROJECT_ID'

    });

}

```

This will return all the data from the project specified.

## Configuration

There are configuration options you can use to return different sets of data, different projections, different datasets, and more.

| property | type | description |

| -------- | ---- | ----------- |

| projectId | string | Your Sanity.io project ID |

| cdn | boolean | Whether or not to use the Sanity CDN for data |

| dataset | string | The dataset name for your Sanity data |

| queries | array | *default returns allData variable with a query of `*[]`* An array of objects providing GROQ queries to return specific queries to specific variables. *Optional*. Each object requires a `varName` and `query` and has an optional `cacheDuration` to override global cache timing. `{ varName: 'NameForTemplate', query: '*[_type == 'something']'` |

| globalCacheDuration | string | *default: 1d*. This is a time string that corresponds to [11ty asset cache plugin times](https://www.11ty.dev/docs/plugins/cache/#change-the-cache-duration). |

## Caching

By default, the plugin will cache the data locally in a `.cache` directory in your project (using 11ty's Asset Cache plugin). It has a global cache timeout of `1d` but can be modified to shorter or longer periods with the `globalCacheDuration` config property or on a specific query with a query optional parameter `cacheDuration`.