A basic Rustyll site usually looks something like this:
.
├── _config.yml
├── _data
│ └── members.yml
├── _drafts
│ ├── begin-with-the-crazy-ideas.md
│ └── on-simplicity-in-technology.md
├── _includes
│ ├── footer.html
│ └── header.html
├── _layouts
│ ├── default.html
│ └── post.html
├── _posts
│ ├── 2007-10-29-why-every-programmer-should-play-nethack.md
│ └── 2009-04-26-barcamp-boston-4-roundup.md
├── _sass
│ ├── _base.scss
│ └── _layout.scss
├── _site
├── .rustyll-cache
│ └── Rustyll
│ └── Cache
│ └── [...]
├── .rustyll-metadata
├── Cargo.toml # for crate-based themes and plugins
└── index.html # can also be an 'index.md' with valid front matter
Directory structure of Rustyll sites using crate-based themes
A new Rustyll project bootstrapped with rustyll new
uses crate-based themes to define the look of the site. This results in a lighter default directory structure: _layouts
, _includes
and _sass
are stored in the theme-crate, by default.
minima is the current default theme, and cargo theme-info rustyll-theme-minima
will show you where minima theme's files are stored on your computer.
An overview of what each of these does:
File / Directory | Description |
---|---|
|
Stores configuration data. Many of these options can be specified from the command line executable but it's easier to specify them here so you don't have to remember them. |
|
Drafts are unpublished posts. The format of these files is without a
date: |
|
These are the partials that can be mixed and matched by your layouts
and posts to facilitate reuse. The liquid tag
|
|
These are the templates that wrap posts. Layouts are chosen on a
post-by-post basis in the
front matter,
which is described in the next section. The liquid tag
|
|
Your dynamic content, so to speak. The naming convention of these
files is important, and must follow the format:
|
|
Well-formatted site data should be placed here. The Rustyll engine
will autoload all data files (using either the |
|
These are sass partials that can be imported into your |
|
This is where the generated site will be placed (by default) once
Rustyll is done transforming it. It's probably a good idea to add this
to your |
|
Keeps a copy of the generated pages and markup (e.g.: markdown) for
faster serving. Created when using e.g.: |
|
This helps Rustyll keep track of which files have not been modified
since the site was last built, and which files will need to be
regenerated on the next build. Only created when using
incremental regeneration (e.g.: with |
|
This file lists the Rust crates your site depends on, including Rustyll
themes and plugins. It's automatically created when you start a new site
with |
|
Provided that the file has a front matter section, it
will be transformed by Rustyll. The same will happen for any |
|
A directory for storing site assets like images, stylesheets, and JavaScript. These will be copied directly to the output directory during build. |
Other Files/Folders |
Every other directory and file except for those listed above—such as
|
Parallel Processing Architecture
Rustyll is designed to process your site in parallel, taking advantage of all available CPU cores. This architecture means:
- Files are read and processed concurrently
- Templates are rendered in parallel when possible
- Assets can be generated simultaneously
This is a major difference from Jekyll’s sequential processing model and explains Rustyll’s significantly faster build times.
Performance Tips
To optimize your site’s build performance:
- Consider using incremental builds with
rustyll serve --incremental
-
Enable aggressive caching in your config:
# _config.yml cache: enabled: true strategy: aggressive
-
For large sites, increase the number of threads:
# _config.yml threads: 8 # or "auto" to use all available cores