Giter VIP home page Giter VIP logo

gatsby-source-salsify's Introduction

gatsby-source-salsify

A Gatsby plugin for using Salsify as a data source.

Install

npm install --save gatsby-source-salsify

or with Yarn:

yarn add gatsby-source-salsify

How to use

// In your gatsby-config.js
plugins: [
	{
		resolve: 'gatsby-source-salsify',
		options: {
			ids: ['U2508', 'U2000'],
			apiKey: "your_salsify_key",
		},
	},
]

Or use markdown files that contain an "id" property in front matter to determine which products to use:

// In your gatsby-config.js
plugins: [
	{
		resolve: 'gatsby-source-salsify',
		options: {
			markdownPath: `${__dirname}/src/markdown/products`,
			apiKey: "your_salsify_key",
		},
	},
]

apiKey is optional if your key is an environment variable. If it is not supplied in the options, it will still try to look for the key in the environment variable process.env.SALSIFY_API_KEY.

Configuration

Types

Salsify's API likes to interchange arrays for strings if there's only one item in the array. To make this more reliable, you can specify arrays with the types option.

options: {
	types: {
		myList: 'array'
	}
}

Media

Salsify's API won't automatically pass along media objects. To specify which properties are supposed to return media objects (which include the URL), use the media option.

options: {
	media: [
		'myImages',
		'videos',
	]
}

How to query

Note: All properties will be converted to camelcase so they play nice with GraphQL.

{
	salsifyContent(id: { eq: $id }){
		itemName
	}
}

gatsby-source-salsify's People

Contributors

kennedyrose avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.