Getting Started with BAX - Quick Start Guide

Step 1 - Install BAX

Clone the repository from GitHub:

git clone https://github.com/mesinkasir/bax.git

cd bax

That's it No other dependencies needed. BAX uses only your system's built-in shell.

Step 2 - Configure Your Site

Edit config.zet with your site information:

SITE_TITLE:My Awesome Site

SITE_URL:https://myawesome.site

SITE_DESCRIPTION:My awesome static site

SITE_IMAGE:https://myawesome.site/og-image.jpg

SITE_FAVICON:/favicon.ico

POSTS_PER_PAGE:6

You can also customize the navigation menu:

NAV:

  - text: Home

    url: /

  - text: About

    url: /about

  - text: Contact

    url: /contact

Step 3 - Create Content

Create .zet files in the data folder. Each file becomes a blog post.

TITLE:My First Post

DATE:15 July 2026

IMG:https://example.com/image.jpg

DESC:This is my first post

TAGS:technology programming

H2:Welcome

P:Welcome to my first blog post

For static pages, create .zet files in the pages folder:

TITLE:About Me

H1:About Me

P:This is my about page.

Step 4 - Build Your Site

Run the build command for your operating system:

Windows

bax.bat

Linux / macOS

chmod +x bax.sh

./bax.sh

The build process takes milliseconds and generates all HTML files in the public folder.

Step 5 - Deploy

Upload the public folder to your hosting provider.

GitHub Pages

mv .github/workflows/deploy.yml.example .github/workflows/deploy.yml

git add .

git commit -m "Deploy BAX site"

git push origin main

Netlify

• Build command: ./bax.sh
• Publish directory: public/

Vercel

• Build command: ./bax.sh
• Output directory: public/

Your Site is Live

Congratulations Your BAX static site is now live on the web.

"BAX makes static site generation simple, fast, and accessible for everyone."

Need help? Check the documentation or open an issue on GitHub.