Installation

How to install Goyo and get started.

Goyo is a theme for Zola. To use this documentation, you need to install Zola first. You can install it on various operating systems with a simple command like the one below.

# macOS Example
brew install zola

For more details, please refer to the official installation guide on the Zola website.

Once you have Zola installed, create a new Zola site as follows:

zola init your-docs
cd docs

You can then run the local development server with the zola serve command and view your site at http://localhost:1111.

Install the Goyo Theme

The easiest way to install a theme in Zola is to clone it or add it as a submodule into the themes subdirectory of your Zola project.

Clone example

git clone https://github.com/hahwul/goyo themes/goyo

Submodule example

git submodule add https://github.com/hahwul/goyo themes/goyo

Update the Goyo Theme

If you want to update the Goyo theme to the latest version, you can do so easily:

  • If you cloned the theme:

    cd themes/goyo
    git pull
    
  • If you added the theme as a submodule:

    git submodule sync
    git submodule update --remote
    

This will ensure you always have the latest features and fixes from the Goyo theme.

Set the theme in config.toml

This is the final step. Set the theme in your config.toml file to use Goyo.

title = "Your App"
theme = "goyo"

Now, when you run Zola, it will use the Goyo theme.

zola serve

However, since you don't have any content yet, you will only see a blank page with a brilliant color. In the next document, we'll create our first page.