Drop our API-based CMS into your Gatsby app in minutes.
ButterCMS provides a component-based CMS and content API for Gatsby and Gatsby.js apps. Use ButterCMS to enable dynamic content in your apps for page content, blogs, and anything else. Most customers get our Gatsby CMS set up in one hour or less.
That leaves plenty of time for you and your marketing team to do what you do best: create killer apps with killer content.
After shopping the market, it was clear that ButterCMS was the perfect choice. It allows our developers to build powerful components and makes it easy for our marketing team to drive a better customer experience.
Hampton Catlin Creator of Sass and Haml
Deploy our Gatsby starter in 30 seconds
Or follow the below commands to clone a copy of the repo from github, install dependencies, set your free Butter token, and
run your local server.
$ git clone https://github.com/ButterCMS/gatsbyjs-starter-buttercms.git
$ cd gatsbyjs-starter-buttercms
$ npm install
$ echo 'BUTTER_CMS_API_KEY=your_free_api_token_here' >> .env
$ npm run develop
ButterCMS is the best headless CMS for Gatsby for a simple reason: Gatsby developers can build solutions that marketing people love. Our API allows your content gurus to quickly spin up high-converting, dynamic landing pages, SEO pages, product marketing pages, and more, all using simple drag-and-drop functionality.
Our mission was to make it easy to integrate Butter with your existing Gatsby app in minutes. It’s so simple! To demonstrate, here’s a mini tutorial to give you a feel for the process of adding marketing pages to your Gatsby or Gatsby.js app.
See how easily you can integrate the ButterCMS Pages API with your Gatsby.js app.
Seamless Gatsby components
Empower your marketing team with dynamic landing pages that align perfectly with your Gatsby components.
Components are the essential building blocks of any Gatsby app, and ButterCMS handles them with ease.
Our drag and drop interface makes it simple to structure your content to match existing Gatsby components and to create new reusable components whenever you need them.
One Gatsby CMS with everything you need
There’s a reason so many developers are choosing a headless Gatsby CMS. It’s easy to set up, offers flexible, customizable content modeling, and gives you access to our full Gatsby API.
Now run gatsby develop in your terminal and open localhost:8000/home to see the home page populated with the content you created on butter.
Configure the source plugin
Here you'll specify the config that will be needed to pull down data from butter. Make sure to add your api_token from your dashboard, in this guide we will add CMS capability to Gatsby for blogging, marketing pages, and more. Below is an example gatsby-config.js file that you'll want to configure for your app. We dive into more detail on the config file in the official guide.
// Example gatsby-config.js filemodule.exports = {
resolve: `gatsby-source-buttercms`,
options: {
authToken: ``,
// Use the optional contentFields array for ButterCMS Collections. Any // Collections you want the app to have access to should have their // slugs explicitly included in the keys array, as seen below. contentFields: {
keys: [`faq_items`, `faq_headline`],
// Optional. Set to 1 to enable test mode for viewing draft content.
test: 0,
},
// Optional. Array of page slugs.
pages: [`homepage`],
// Optional. Array of page types. // Use the optional pageTypes array for ButterCMS PageTypes. Any // Page Types you want the app to have access to should have their // slugs explicitly included in the pageTypes array, as seen below.
pageTypes: [`customer_case_study`], // Specify locales you want the app to have access to, if you have // locales enabled in your account. locales: [`en`, `fr`]
},
},
}
That's it! If you browse to your homepage you'll see your homepage populated with the content you created in Butter.