> ## Documentation Index
> Fetch the complete documentation index at: https://buttercms.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

<Info>
  **One-Click Deploy**: Skip local setup and [deploy to Vercel instantly](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FButterCMS%2Fbuttercms-hugo\&env=BUTTER_CMS_API_KEY\&envDescription=Your%20ButterCMS%20API%20Token\&envLink=https%3A%2F%2Fbuttercms.com%2Fsettings%2F).
</Info>

## Quick start

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

```bash theme={null}
$ 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.

```bash theme={null}
$ echo 'BUTTERCMS_API_TOKEN=your_token' >> .env
```

To fetch your ButterCMS content run:

```bash theme={null}
$ 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:

```bash theme={null}
$ hugo server
```

**Local Development**: [http://localhost:1313/](http://localhost:1313/)

**GitHub Repository**: [https://github.com/ButterCMS/buttercms-hugo](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

<CardGroup cols={1}>
  <Card title="Deploy to Netlify" icon="square" href="https://app.netlify.com/start/deploy?repository=https://github.com/ButterCMS/buttercms-hugo">
    One-click deploy to Netlify
  </Card>
</CardGroup>

## Resources

<CardGroup cols={2}>
  <Card title="GitHub Repository" icon="github" href="https://github.com/ButterCMS/buttercms-hugo">
    View source code and contribute
  </Card>

  <Card title="Hugo Guide" icon="book" href="../../frameworks/non-javascript-frameworks/hugo">
    Framework integration guide
  </Card>
</CardGroup>

## Additional reading

* [Creating a Static Website with Hugo and ButterCMS!](https://buttercms.com/blog/creating-a-static-website-with-hugo-and-buttercms/)
* [New Blog Post UI and Write API Capabilities](https://buttercms.com/blog/new-blog-post-ui-collection-items-write-api/)
* [6 of the Best Static Site Generators in 2021](https://buttercms.com/blog/6-of-the-best-static-site-generators-in-2020/)

## Next steps

<CardGroup cols={2}>
  <Card title="Core Concepts" icon="book" href="../../core-concepts/content-types/pages">
    Learn about Pages, Collections, and Components
  </Card>

  <Card title="API Reference" icon="code" href="../../api">
    Explore the full ButterCMS API
  </Card>
</CardGroup>