A Better Web Initiative Project
- Lightning-fast build times ⚡
- Compatible with Jekyll sites and themes 🔄
- Markdown rendering with extensive customization options 📝
- Liquid templating engine with powerful filters and tags 💧
- Built-in development server with live reload 🔄
- Flexible configuration system 🔧
- Modern front matter support (YAML, TOML, JSON) 📋
- Advanced asset processing pipeline 🏗️
- Incremental builds for large sites 🚀
- Comprehensive site reporting and analysis tools 📊
---
## Philosophy
Rustyll was born from the belief that static site generation should be:
- **Fast without compromise**: Build times should be measured in milliseconds, not minutes.
- **Familiar yet powerful**: Compatible with existing Jekyll sites while offering powerful new capabilities.
- **Extensible by design**: A plugin system that makes it easy to extend functionality.
- **Modern and future-proof**: Built with modern Rust for reliability, security, and performance.
- **Developer-friendly**: Clear error messages, comprehensive documentation, and sensible defaults.
As part of the **Better Web Initiative**, we're committed to making the web faster, more accessible, and more sustainable. We believe that by building tools that respect these principles, we can contribute to a web that works better for everyone.
## Why Rustyll?
Rustyll combines the best of both worlds: the familiar Jekyll ecosystem with the performance and safety of Rust. Whether you're migrating an existing Jekyll site or starting fresh, Rustyll offers significant advantages:
- **Dramatically faster builds** - Sites build 10-100x faster than with Ruby-based Jekyll
- **Memory efficient** - Build even the largest sites with minimal RAM requirements
- **Improved security** - Benefit from Rust's memory safety and security guarantees
- **Modern features** - Advanced asset pipelines, better incremental builds, and more
- **Jekyll compatibility** - Use existing Jekyll themes and plugins with minimal changes
## Getting Started
### Installation
#### Using cargo:
```bash
cargo install rustyll
```
#### macOS (Homebrew):
```bash
brew install rustyll
```
#### Linux:
```bash
curl -sSL https://get.rustyll.dev | sh
```
#### Windows:
```bash
winget install rustyll
```
### Quick Start
Create a new site:
```bash
rustyll new my-awesome-site
cd my-awesome-site
```
Build your site:
```bash
rustyll build
```
Serve your site locally:
```bash
rustyll serve
```
## Features
### Core Features
- **Fast Builds**: Build even large sites in milliseconds
- **Jekyll Compatibility**: Easy migration from Jekyll
- **Markdown Processing**: Advanced markdown rendering with extensions
- **Liquid Templates**: Powerful templating with custom filters and tags
- **Front Matter**: Support for YAML, TOML and JSON front matter
- **Layouts**: Flexible layout system with inheritance
- **Collections**: Organize and manage content collections
- **Data Files**: Import data from YAML, JSON, CSV, and more
- **Assets Pipeline**: Process CSS, JavaScript, and images
- **Development Server**: Built-in server with live reload
### Advanced Features
- **Incremental Builds**: Only rebuild what changed
- **Site Reports**: Generate detailed reports about your site
- **Migration Tools**: Easily migrate from other static site generators
- **Watch Mode**: Automatically rebuild when files change
- **Powerful CLI**: Comprehensive command line interface
- **Configuration**: Flexible configuration system
- **Plugin System**: Extend functionality with plugins
## Command Line Usage
```
USAGE:
rustyll [OPTIONS] [SUBCOMMAND]
OPTIONS:
-s, --source