sukr/docs/content/getting-started.md at d6d230e9f29d3f56b484a8f37701eae9e9598ef9

Files

Timothy DeHerrera 46c00c7729 docs: migrate content files to TOML frontmatter

Migrate all 17 docs/content/ files from --- YAML to +++ TOML
frontmatter delimiters and key = value syntax.

Update 8 embedded frontmatter examples in 7 documentation pages
to match (configuration, content-organization, getting-started,
security, sections, sitemap, feeds, templates).

Update configuration.md frontmatter reference table: add draft
and aliases fields, correct date type from string to date.

2026-02-14 06:57:55 -07:00

2.3 KiB

Raw Blame History

+++ title = "Getting Started" description = "Install sukr and build your first site" weight = 0 +++

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

Create templates/base.html:

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>{{ title }} | {{ config.title }}</title>
    <link rel="stylesheet" href="{{ prefix }}/style.css" />
  </head>
  <body>
    <main>{% block content %}{% endblock content %}</main>
  </body>
</html>

Create templates/page.html:

{% extends "base.html" %} {% block content %}
<article>
  <h1>{{ page.title }}</h1>
  {{ content | safe }}
</article>
{% endblock content %}

Create templates/content/default.html:

{% extends "base.html" %} {% block content %}
<article>
  <h1>{{ page.title }}</h1>
  {{ content | safe }}
</article>
{% endblock content %}

Your templates directory should look like this:

templates/
├── base.html
├── page.html
└── content/
    └── default.html

5. Build

sukr

6. View your site

Open public/index.html in your browser. You should see your "Hello, World!" page rendered with the template you created.

Next Steps

Deployment — put your site on the web
Configuration — customize site.toml options (paths, navigation, base URL)
Content Organization — learn how directories map to site sections
Features — syntax highlighting, math, diagrams, and more

2.3 KiB Raw Blame History