352b3c1941
- Add content-organization.md explaining filesystem-to-URL mapping - Add feeds.md for Atom feed generation - Add css.md for CSS minification - Fix em dash in css.md Documents core implicit behavior: directory structure → site layout.
1.1 KiB
1.1 KiB
title, description, weight
| title | description | weight |
|---|---|---|
| Getting Started | Install sukr and build your first site | 0 |
Getting Started
This guide walks you through installing sukr and creating your first static site.
Installation
From source (recommended)
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
- Learn about Configuration
- Explore Features