Getting Started

The quickest way to get up and running with Satellite is using the provided quickstart-site archive.

This guide assumes basic knowledge of Hugo website structure, and Hugo’s CLI. Specifically, hugo for building sites and hugo server hot reload server.

For best compatibility, use Hugo v0.81.0. Newer versions should work fine.

Download and Installation

Head over to Satellite’s releases on Github and download the latest quickstart-site archive. Extract the quickstart-site archive to an empty folder. The site should be ready to build.

Development Server

To run a hot-reload development server, run Hugo server inside the folder containing the site:

$ hugo server

Production Build

To build the site, run Hugo inside the folder containing the site:

$ hugo

Further Configuration

Your site should be ready for you to start writing content. For futher configuration, check out menu and navigation customization, color customization and other documentation pages.