Quickstart
Prerequisites
- Rust 1.75 or later
Install
cargo install listsome
Create a Site
listsome init my-projects
cd my-projects
This creates listsome.toml, a projects/ directory, and a .gitignore. Edit listsome.toml to set your site name, author, URL, and webmention endpoint. See the configuration reference for details.
Add a Project
listsome new smart-thermostat --title "Smart Thermostat" --difficulty intermediate
Edit projects/smart-thermostat/index.md with your content.
Build
listsome build
Generates output/index.html, output/<slug>/index.html for each project, and output/rss.xml.
Preview
listsome serve --open
Opens a browser at http://127.0.0.1:8080 with live reload. Edit your project files and the browser refreshes automatically.
Deploy
Copy the output/ directory to any static host (Netlify, Codeberg Pages, S3, nginx, etc.).
Command-Line Tool Reference
| Command | Description |
|---|---|
listsome init [PATH] | Initialize a new site |
listsome new <SLUG> | Create a new project |
listsome build | Build the static site |
listsome serve | Start development server |
listsome check [PROJECT] | Validate projects |
listsome list | List projects with filters |
listsome webmention fetch|show|test | Webmention management (coming soon) |
Global flags: -v (verbose), -q (quiet), -C <FILE> (config path), --color <WHEN>.