logo

๐Ÿš€ Slamhaus Quickstart

Build a complete, styled static website in just 3 steps.

No runtime, no boilerplate, no JS โ€” just Markdown in, HTML out.


๐Ÿงญ 3-Step Setup

๐Ÿ› 

1. Download + Unpack

Pick your platform:

Unzip it.

On Linux:

chmod +x slamhaus

๐Ÿ“

2. The content/ Folder

Put your Markdown files and media into a folder like this:

your-project/
โ”œโ”€โ”€ slamhaus-executable
โ””โ”€โ”€ content/
    โ”œโ”€โ”€ index.slam
    โ””โ”€โ”€ include/
        โ””โ”€โ”€ nav.smd

Slamhaus comes with a default template, find more on Github.

โ–ถ๏ธ

3. Build + View

Build your site:

./slamhaus

Your static site is now in the output/ folder.

Open index.html in any browser or host with a local server.

On Windows:

run slamhaus-windows.exe


๐Ÿงช Want to Build From Source?

Clone the repo and run:

git clone https://github.com/bitboyb/Slamhaus
cd Slamhaus
make

Requires C++17 and make. See full setup in the README on GitHub โ†’