Skip to content
Balzac

Quick Start

Create a simple static site in just a few steps.

Step 1: Initialize Project

Section titled “Step 1: Initialize Project”

Create a new directory for your project:

Terminal window
mkdir my-site
cd my-site

Step 2: Create Configuration

Section titled “Step 2: Create Configuration”

Create a balzac.toml file in your project root:

# Optional configuration - using defaults
[global]
site_name = "My Site"

Step 3: Create Your First Page

Section titled “Step 3: Create Your First Page”

Create the pages directory and add an index.hbs file:

Terminal window
mkdir -p pages

pages/index.hbs:

<!DOCTYPE html>
<html>
  <head>
    <title>{{site_name}}</title>
  </head>
  <body>
    <h1>Welcome to {{site_name}}</h1>
    <p>Hello, Balzac!</p>
  </body>
</html>

Step 4: Build Your Site

Section titled “Step 4: Build Your Site”

Run Balzac to generate your site:

Terminal window
balzac build

Your site will be built in the dist/ directory.

Step 5: View Your Site

Section titled “Step 5: View Your Site”

Open the generated HTML file in your browser:

Terminal window
open dist/index.html

Or use a local server:

Terminal window
python3 -m http.server --directory dist 8000

Then visit http://localhost:8000

What’s Next?

Section titled “What’s Next?”