Hugo starter project

Get up and running with Hugo and ButterCMS in under two minutes, with a starter that showcases Pages, Collections, and a Blog engine.

One-Click Deploy: Skip local setup and deploy to Vercel instantly.

Quick start

First, create a virtual environment and install dependencies by running the below commands.

$ git clone https://github.com/ButterCMS/hugo-starter-buttercms.git
$ cd hugo-starter-buttercms
$ go mod download

To fetch your ButterCMS content, add your API token as an environment variable.

$ echo 'BUTTERCMS_API_TOKEN=your_token' >> .env

To fetch your ButterCMS content run:

$ go run github.com/ButterCMS/hugo-starter-buttercms/prebuild

To view the app in the browser, you’ll need to run the local development server:

$ hugo server

Local Development: http://localhost:1313/

GitHub Repository: https://github.com/ButterCMS/buttercms-hugo

What’s included

Feature	Description
Pages & Page Types	Pre-built page templates with drag-and-drop schema definition
Components	Modular content blocks for dynamic landing pages
Collections	Structured data for navigation, testimonials, FAQs
Blog Engine	Full blog with posts, categories, tags, and search
Media CDN	Automatic image optimization via Filestack

Deploy options

Deploy to Netlify

One-click deploy to Netlify

Resources

GitHub Repository

View source code and contribute

Hugo Guide

Framework integration guide

Additional reading

• Creating a Static Website with Hugo and ButterCMS!
• New Blog Post UI and Write API Capabilities
• 6 of the Best Static Site Generators in 2021

Next steps

Core Concepts

Learn about Pages, Collections, and Components

API Reference

Explore the full ButterCMS API