Getting Started

Install sukr and build your first site

This guide walks you through installing sukr and creating your first static site.

Installation

git clone https://github.com/nrdxp/sukr
cd sukr
cargo install --path .

With Nix

nix build github:nrdxp/sukr
./result/bin/sukr --help

Create Your First Site

1. Create directory structure

mkdir my-site && cd my-site
mkdir -p content templates static

2. Create configuration

Create site.toml:

title    = "My Site"
author   = "Your Name"
base_url = "https://example.com"

3. Create homepage

Create content/_index.md:

---
title: Welcome
description: My awesome site
---

# Hello, World!

This is my site built with sukr.

4. Create templates

Copy the default templates from the sukr repository, or create your own Tera templates.

5. Build

sukr

Your site is now in public/.

Next Steps