Getting Started

Installation

Prerequisites

Build the CLI

Clone the repository and build Spaz:

git clone https://github.com/yourusername/spaz.git
cd spaz
cargo build --release

The binary will be available at target/release/spaz. That’s all you need—no additional tools or modules required.

Add to PATH

For easy access, add the binary to your PATH:

# On macOS/Linux
ln -s $(pwd)/target/release/spaz /usr/local/bin/spaz

# Or add to your shell profile
export PATH="$PATH:$(pwd)/target/release/spaz"

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.html)

Create about.md:

# About

This is the about page.

[Back Home](/index.html)

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