Getting Started

Installation

Downloads coming soon!

Prerequisites

Build the CLI

Clone the repository and build Spaz:

git clone https://github.com/lucky/spaz.git
cd spaz
cargo install --path .

Your First Site

1. Create a Content Directory

mkdir my-docs
cd my-docs

2. Create Markdown Files

Create index.md:

# Welcome

This is my first Spaz site!

[Learn More](/about/)

Create about.md:

# About

This is the about page.

[Back Home](/)

3. Generate the Site

spaz --input . --output dist

4. View Your Site

cd dist
python3 -m http.server 8000

Open http://localhost:8000/index.html in your browser.

Notes

No special setup is required. Everything you need is compiled into the Spaz binary. The generated sites work instantly with just plain JavaScript—no external dependencies or build steps.

Next Steps