Quick Start

Prerequisites

1. Install Golda
2. Install Git

Create a project

Verify your version of Golda

golda version

Run these commands to create a Golda project.

golda new project quickstart # Create a project skeleton
cd quickstart # Change directory to the root of your project
git init # Initialize an empty Git repository in the current directory
git submodule add [theme-repository-url] themes/[theme-name] # Add a theme to the themes directory as a submodule
echo "theme = '[theme-name]'" >> golda.toml # Apply the theme by appending this line to the configuration file
golda serve # Start Golda's development server

View your project at the URL displayed in your terminal. Press CTRL + C to stop the development server.

Add content

Add a new page

golda new content content/posts/my-first-post.md

Open the file with your editor

+++
title = 'My First Post'
date = 2024-01-14T07:07:07+01:00
draft = true
+++

Notice the draft value in the front matter is true. Golda does not publich draft content when you build the project.

Open with your editor and add some Markdown content beneath the front matter.

Then, save and start Golda’s development server. The -D flag indicates that draft content will be included.

golda serve -D

Configure the project

baseURL = 'https://example.org'
locale = 'en-us'
title = 'My New Golda Project'
theme = 'dead-simple'

Make the following changes:

1. Set the baseURL for your production site. This value must begin with the protocol and end with a slash, as shown above.
2. Set the languageCode to your language and region.
3. Set the title for your production site.

Start Golda’s development server to see your changes, remembering to include draft content.

golda server -D

Most theme authors provide configuration guidelines and options. Make sure to visit your theme’s repository or documentation site for details.