servius/sukr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc(README): update to reflect current state

Browse Source
This commit is contained in:
Timothy DeHerrera
2026-02-01 11:19:45 -07:00
parent f38303b7e0
commit 73459e5d17
1 changed files with 23 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -6,13 +6,18 @@
**Minimal static site compiler — suckless, Rust, zero JS.** **Minimal static site compiler — suckless, Rust, zero JS.**
sukr transforms Markdown content into high-performance static HTML. No bloated runtimes, no unnecessary JavaScript, just clean output. sukr transforms Markdown content into high-performance static HTML. No bloated runtimes, no client-side JavaScript, just clean output.
## Features ## Features
- **Build-time rendering** — Syntax highlighting via Tree-sitter, no client JS - **Syntax highlighting** — Tree-sitter with language injection (Nix→Bash, HTML→JS/CSS)
- **Tera templates** — Runtime customizable, no recompilation needed - **Math rendering** — LaTeX to HTML via KaTeX at build time
- **Convention over configuration** — Add sections by creating directories - **Mermaid diagrams** — Rendered to inline SVG, no client JS
- **Tera templates** — Customize without recompiling
- **Hierarchical navigation** — Nested sections with table of contents
- **Atom feeds** — Auto-generated for blog sections
- **Sitemap** — SEO-ready XML sitemap
- **CSS minification** — LightningCSS optimization
- **Monorepo support** — Multiple sites via `-c` flag - **Monorepo support** — Multiple sites via `-c` flag
## Quick Start ## Quick Start
@@ -25,10 +30,7 @@ cargo build --release
sukr sukr
# Custom config (monorepo) # Custom config (monorepo)
sukr -c sites/blog/site.toml sukr -c docs/site.toml
# Help
sukr --help
``` ```
## Configuration ## Configuration
@@ -40,11 +42,15 @@ title = "My Site"
author = "Your Name" author = "Your Name"
base_url = "https://example.com" base_url = "https://example.com"
[paths] # All optional [paths] # All optional, defaults shown
content = "content" # default content = "content"
output = "public" # default output = "public"
static = "static" # default static = "static"
templates = "templates" # default templates = "templates"
[nav] # Optional
nested = false # Show section children in nav
toc = false # Enable table of contents
``` ```
## Content Structure ## Content Structure
@@ -58,6 +64,10 @@ content/
└── my-post.md # Post → /blog/my-post.html └── my-post.md # Post → /blog/my-post.html
``` ```
## Documentation
Full documentation at [sukr.io](https://sukr.io) (built with sukr).
## License ## License
MIT MIT