Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install veltox

It will make the veltox command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall veltox uninstalls.

Back to the crate overview.

Readme

Veltox

Veltox is a blazing-fast, themeable static site generator written in Rust — perfect for documentation, blogs, and technical sites. It converts Markdown files into HTML using customizable templates, generates a dynamic sidebar, and builds a searchable index for client-side search or content listing.

✨ Features

📝 Markdown to HTML conversion with YAML frontmatter support
🎨 Theme system with Tera templates and custom CSS
📁 Dynamic sidebar generation based on your content structure
🔍 Search index (search-index.json) for building search bars or blog listings
📦 Self-contained output — all assets and templates copied into public/
⚡ Fast and minimal — no JavaScript required, no runtime dependencies

📦 Installation

Install via Cargo:

cargo install veltox

Or build from source:

git clone https://github.com/yourname/veltox
cd veltox
cargo build --release

🚀 Usage

Place your Markdown files in a content/ folder:

# content/intro.md

---
title: "Welcome"
template: "page.html"
---

# Hello

This is your first Veltox page.

Then run:

veltox

Veltox will generate your site in the public/ folder.

🎨 Themes

Themes live in themes/<name>/ and include:

themes/
└── docs/
    ├── templates/
    │   └── page.html
    └── theme.css

Set your theme in veltox.toml:

theme = "docs"

Veltox copies the selected template and CSS into public/, ensuring all links are relative and portable.

🔍 Search Index

Veltox automatically generates a search-index.json containing:

[
  {
    "title": "Welcome",
    "url": "./intro.html",
    "content": "Markdown content here..."
  }
]

Use this for client-side search, blog listings, or tag filters.

🧩 Plugin System (Planned)

Veltox is designed to be extensible. A plugin system is planned to allow hooks like:

on_load
on_render
on_index
on_finish

Stay tuned!

📄 License

MIT

❤️ Built With

Veltox is built to document real Rust projects — like the web framework it was born to support. Use it, fork it, extend it. It’s yours.