Rustyll is a static site generator written in Rust. Write content in Markdown, shape it with Liquid templates, and generate a website you can host as static files. If you have a Jekyll site, the familiar structure can help you get started; review plugins and configuration when you migrate.
Why Choose Rustyll?
- Rust-powered: Build a static site with a tool written in Rust.
- Content-focused: Keep writing in Markdown and organize content in files.
- Familiar templates: Use Liquid layouts and includes to shape your pages.
- Portable output: Publish the generated files with your preferred static host.
- Migration guides: Review the changes needed for an existing project.
Prerequisites
Rustyll requires the following:
- Rust version 1.75 or higher
- Cargo (comes with Rust)
See Requirements for guides and details.
Instructions
- Install all prerequisites.
- Install Rustyll using Cargo.
cargo install rustyll - Create a new Rustyll site at
./myblog.rustyll new myblog - Change into your new directory.
cd myblog - Build the site and make it available on a local server.
rustyll serve - Browse to http://localhost:4000
Pass the --livereload option to serve to automatically refresh the page with each change you make to the source files: rustyll serve --livereload
For build options available in your installed release, run rustyll serve --help.
Migration from Jekyll
If you have an existing Jekyll site:
- Install Rustyll
- Navigate to your Jekyll site directory
- Follow the Jekyll migration guide to review configuration, templates and plugins.
- Run
rustyll serveand check the generated site.
Next steps
Explore the step by step tutorial, deployment guide and published releases. Build times vary by project; compare tools using your own site’s content and configuration.
If you encounter any errors during this process, check that you have installed all the prerequisites in Requirements. If you still have issues, see Troubleshooting.
Installation varies based on your operating system. See our guides for OS-specific instructions.