Run this in your commandline:

npm install buttercms --save

Or if you're using Yarn:

yarn install buttercms

The source code is available on Github.

Set your API token:

var butter = require('buttercms')('your_api_token');

Or if using ES6 syntax:

import Butter from 'buttercms';
const butter = Butter('your_api_token');

Then run:

butter.post.list({page: 1, page_size: 10}).then(function(response) {
  console.log(response)
})

This API request fetches your blog posts. Your account comes with one example post which you'll see in the response.

Next, run:

butter.content.retrieve(['homepage_headline']).then(function(response) {
  console.log(response)
});

This API request fetches homepage headline content. You can setup your own custom content fields to manage any content kind of content you need.

ButterCMS lets you manage content using our dashboard and integrate it into your front-end of choice with our API. You can use ButterCMS for new projects as well as add it to existing codebases.

ButterCMS comes with a blogging interface and APIs for blog posts, categories, authors, and XML feeds. For other use cases you can setup custom content fields based on your needs.

For example, if you wanted to enable a non-technical person to edit some copy on your homepage, you might create two custom content fields called "Homepage Headline" and "Homepage Main Paragraph". The non-technical person would be able to edit the values of the fields and the JSON API output would look something like this:

{
  "homepage_headline": "OMG I can edit this!",
  "homepage_paragraph": "I love ButterCMS"
}

Custom content fields can be used for more complex cases like creating dynamic pages and managing knowledgebases, which we will cover in this guide.

Table of Contents

Introduction

Learn how to quickly build a custom blog with great SEO. Butter integrates with any Node.js server and templating engines like Mustache, Jade, and React. This guide uses the Express framework and EJS templates. Full working example code is available on Github and as this Heroku Deploy Button:

Deploy

If you need help after reading this, contact us via email, livechat, or book a time with to pair with one of our developers.

Display posts

To display posts we create a simple /blog route in our app and fetch blog posts from the Butter API. See our API reference for additional options such as filtering by category or author. The response also includes some metadata we'll use for pagination.

var express = require('express');
var butter = require('buttercms')('your_api_token');
var app = express()

app.set('view engine', 'ejs');

app.get('/blog', renderHome)
app.get('/blog/p/:page', renderHome)

app.listen(3000)

function renderHome(req, res) {
  var page = req.params.page || 1;

  butter.post.list({page_size: 10, page: page}).then(function(resp) {
    res.render('index', {
      posts: resp.data.data,
      next_page: resp.data.meta.next_page,
      previous_page: resp.data.meta.previous_page
    })
  })
}

Next we'll create an EJS template for displaying our posts and pagination links. This guide uses EJS templates but Butter works with any templating engine like Jade, Mustache, and React. If you need help after reading this, contact us via email, livechat, or book a time with to pair with one of our developers.

<h2>Blog</h2>

<% posts.forEach(function(post) { %>
  <a href="/blog/<%= post.slug %>"><%= post.title %></a> by <%= post.author.first_name %> <%= post.author.last_name %>
  <br>
<% }); %>

<% if (previous_page) { %>
  <a href="/blog/p/<%= previous_page %>">Prev</a>
<% } %>

<% if (next_page) { %>
  <a href="/blog/p/<%= next_page %>">Next</a>
<% } %>

We'll also create an additional route for displaying individual posts:

app.get('/blog/:slug', renderPost)

function renderPost(req, res) {
  var slug = req.params.slug;

  butter.post.retrieve(slug).then(function(resp) {
    res.render('post', {
      title: resp.data.data.title,
      post: resp.data.data,
      published: new Date(resp.data.data.published)
    })
  })
}

The template for displaying a full post includes information such as author and publish date. See a full list of available post properties in our API reference.

<h2><%= post.title %></h2>

Published <%= published.getDate() %>/<%= published.getMonth()+1 %>/<%= published.getFullYear() %>

<% if (post.categories.length > 0) { %>
  in 
  <% post.categories.forEach(function(cat) { %>
    <a href="/category/<%= cat.slug %>"><%= cat.name %></a> 
  <% }); %>
<% } %>

<br>

<%= post.author.first_name %> <%= post.author.last_name %>

<div>
  <%- post.body %>
</div>

Categories, Tags, and Authors

Use Butter's APIs for categories, tags, and authors to feature and filter content on your blog:

app.get('/category/:slug', renderCategory)

function renderCategory(req, res) {
  var slug = req.params.slug;

  butter.category.retrieve(slug, {include: 'recent_posts'})
    .then(function(resp) {
      res.render('category', {
        title: resp.data.data.name,
        category: resp.data.data
      })
    })
}

See our API reference for more information about these objects:

RSS, Atom, and Sitemap

Butter generates RSS, Atom, and sitemap XML markup. To use these on your blog, return the generated XML from the Butter API with the proper content type headers.

app.get('/rss', function(req, res) {
  res.set('Content-Type', 'text/xml');

  butter.feed.retrieve('rss').then(function(resp) {
    res.send(resp.data.data)
  })
});

app.get('/atom', function(req, res) {
  res.set('Content-Type', 'text/xml');

  butter.feed.retrieve('atom').then(function(resp) {
    res.send(resp.data.data)
  })
});

app.get('/sitemap', function(req, res) {
  res.set('Content-Type', 'text/xml');

  butter.feed.retrieve('sitemap').then(function(resp) {
    res.send(resp.data.data)
  })
});

Comments

Butter doesn't provide an API for comments due to the excellent existing options that integrate easily. Two popular servies we recommend are:

Both products are free, include moderation capabilities, and give your audience a familiar commenting experience. They can also provide some additional distribution for your content since users in their networks can see when people comment on your posts. For a minimalist alternative to Disqus, check out RemarkBox or for an open-source option, Isso.

CSS

Butter integrates into your front-end so you have complete control over the design of your blog. The rich text editor allows for formatting that you'll want to make sure you have styled. The boilerplate CSS covers most cases:

.post-container {
  h1, h2, h3, h4, h5 {
    font-weight: 600;
    margin-bottom: 1em;
    margin-top: 1.5em;
  }

  ul, ol {
    margin-bottom: 1.25em;

    li {
      margin-bottom: 0.25em;
    }
  }

  p {
    font-family: Georgia, Cambria, "Times New Roman", Times, serif;
    font-size: 1.25em;
    line-height: 1.58;
    margin-bottom: 1.25em;
    font-weight: 400;
    letter-spacing: -.003em;
  }

  /* Responsive default image width */
  img {
    max-width: 100%;
    height: auto;
  }

  /* Responsive floating */
  @media only screen and (min-width: 720px)  {
    .butter-float-left {
      float: left;
      margin: 0px 10px 10px 0px;
    }

    .butter-float-right {
      float: right;
      margin: 0px 0px 10px 10px;
    }
  }

  /* Image caption */
  figcaption {
    font-style: italic;
    text-align: center;
    color: #ccc;
  }

  /* Inline code highlighting */
  p code {
    padding: 2px 4px;
    font-size: 90%;
    color: #c7254e;
    background-color: #f9f2f4;
    border-radius: 4px;
    font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
  }

  pre {
    display: block;
    padding: 1em;
    margin: 0 0 2em;
    font-size: 1em;
    line-height: 1.4;
    word-break: break-all;
    word-wrap: break-word;
    color: #333333;
    background-color: #f5f5f5;
    font-family: Menlo, Monaco,Consolas, "Courier New", monospace;
  }
}

Migration

To import content from another platform like WordPress or Medium, send us an email.

Table of Contents

Introduction

Learn how to make content on a static page editable using Butter.

Making your content dynamic with Butter is a two-step process:

  1. Setup custom content fields in Butter
  2. Integrate the fields into your application

This guide uses the Express framework and EJS templates but Butter integrates with any Node.js server and templating engines like Jade, Mustache, and React.

If you need help after reading this, contact us via email, livechat, or book a time with to pair with one of our developers.

Setup content fields

Let's suppose we want to add a CMS to a static FAQ page with a title and a list of questions with answers. Here's the initial code for the server and static page with the Butter API client installed:

app.js:

var express = require('express');
var butter = require('buttercms')('your_api_token');

var app = express()

app.set('view engine', 'ejs');

// Routes
app.get('faq', function() {
  res.render('faq')
});

views/faq.ejs:

<h1>FAQ</h1>

<ul>
  <li>
    <h4>When was this company started?</h4>
    <p>2014</p>
  </li>
  <li>
    <h4>What forms of payment do you accept?</h4>
    <p>Credit cards and checks.</p>
  </li>
</ul>

Making your content dynamic with Butter is a two-step process:

  1. Setup custom content fields in Butter
  2. Integrate the fields into your application

To setup custom content fields, first sign in to the Butter dashboard.

Create a new workspace or click on an existing one. Workspaces let you organize content fields in a friendly way for content editors and have no effect on development or the API. For example, a real-estate website might have a workspace called "Properties" and another called "About Page".

Once you're in a workspace click the button to create a new content field. Choose the "Object" type and name the field "FAQ Headline":

After saving, add another field but this time choose the "Collection" type and name the field FAQ Items:

On the next screen setup two properties for items in the collection:

Now go back to your workspace and update your heading and FAQ items.

Integrate your app

To display this dynamic content in our app, we fetch the fields with an API call and then reference them in our view. Here's what the code looks like:

app.js:

var express = require('express');
var butter = 'require(buttercms')('your_api_token');

var app = express()

app.set('view engine', 'ejs');

// Routes
app.get('faq', function() {
  butter.content.retrieve(["faq_headline", "faq_items"]).then(function(resp) {
    var content = resp.data.data;

    res.render('faq', {
      content: data
    })
  });
});

views/faq.ejs:

<h1><%= content.faq_headline %></h1>

<ul>
  <% content.faq_items.forEach(function(item) { %>
    <li>
      <h4><%= item.question %></h4>
      <p><%= item.answer %></p>
    </li>
  <% }); %>
</ul>

That's it! The values entered in the Butter dashboard will immediately update the content in our app.

If you need help after reading this, contact us via email, livechat, or book a time with to pair with one of our developers.

Table of Contents

Introduction

Learn how to create dynamic pages using Butter.

Creating dynamic pages with Butter is a two-step process:

1) Setup custom content fields in Butter
2) Integrate the fields into your application

This guide uses the Express framework and EJS templates but Butter integrates with any Node.js server and templating engines like Jade, Mustache, and React. If you need help after reading this, contact us via email, livechat, or book a time with to pair with one of our developers.

Setup content fields

Let's suppose we want to be able to create pages for retail-chain locations using ButterCMS and we're starting out with a basic static page template for a single location:

app.js:

var express = require('express');
var butter = require('buttercms')('your_api_token');

var app = express()

app.set('view engine', 'ejs');

// Routes
app.get('/locations/:slug', function() {
  res.render('location')
});

views/location.ejs:

<h1>Widget Store - Chicago</h1>
<img src="/images/chicago.jpg">
<p>Our Chicago location is located at 566 Wacker Drive.</p>

Enabling new pages to be created with Butter is a two-step process:

  1. Setup custom content fields in Butter
  2. Integrate the fields into your application

To setup custom content fields, first sign in to the Butter dashboard.

Create a new workspace or click on an existing one. Workspaces let you organize content fields in a friendly way for content editors and have no effect on development or the API. For example, a real-estate website might have a workspace called "Properties" and another called "About Page".

Once you're in a workspace click the button to create a new content field. Choose the "Collection" type and name the field "Location Pages":

On the next screen, we'll setup the properties for each page in the collection.

Now go back to the work space and create a location:

Integrating your app

To create these pages in our app, we create a dynamic route that fetches content for the page by using a URL parameter. Here's what the code looks like:

app.js:

var express = require('express');
var butter = require('buttercms')('your_api_token');

var app = express()

app.set('view engine', 'ejs');

// Routes
app.get('/locations/:slug', function() {
  butter.content.retrieve(['location_pages[slug='+params.slug+']']).then(function(resp) {
    var content = resp.data.data;

    // location_pages is a collection so we access the first and only item
    var location = content.location_pages[0];

    res.render('location', {
      location: location
    })
  });
});

views/location.ejs:

<h1>Widget Store - <%= location.name %></h1>
<img src="<%= location.feature_image %>">
<p><%= location.description %></p>

That's it! If you browse to /locations/chicago, you'll see the content we just entered into Butter.

If you need help after reading this, contact us via email, livechat, or book a time with to pair with one of our developers.

Get started now

Sign up with Google Sign up with Github
or