Site is a fast, simple, and opinionated static site generator written in Rust. Its main features are:

• Markdown-based: Write your content in Markdown with extensions, powered by pulldown_cmark.
• Jinja2 Templates: Uses the minijinja engine for templating.
• Fast & Simple: Blazingly fast, with parallel processing of articles.
• Inspired by Pelican: Borrows the concepts of Articles and Pages from the Python static site generator Pelican.
• Opinionated by Design: Implements only what the author needs for a simple static site like hayatoito.github.io. For custom features, forking is recommended. The codebase is intentionally small, making it easy to understand and modify.

cargo install site

There is no documentation yet.

In the meantime, you can use the hayatoito/hayatoito.github.io repository as a starter template. The author's site, hayatoito.github.io, is built from this repository.

root_dir/
 - src/
   - (Your markdown files go here)
 - template/
   - (Your template files go here)

• src/: This directory contains all your Markdown files. They are converted to HTML using Jinja2 templates and placed in the output directory. Any other files in this directory are also copied to the output directory.

• template/: This directory holds your Jinja2 template files.

Site uses Markdown with TOML front matter for metadata.

# Article title

<!--
date = "2021-12-01"
-->

# Section

Hello Article!

- hello
- world

If a Markdown file's metadata contains page = true, Site treats it as a page instead of an article.

# Page title

<!--
page = true
-->

# Section

Hello Page!

- hello
- world

The main differences between an article and a page are:

• A page is not included in the articles or articles_by_year template variables.
• A page does not require a date in its metadata.

An article template does not have access to other articles.

The entry object contains all the metadata fields, plus the following:

site build --root . --out out --config=config.toml

The root directory must contain src and template directories. For more examples, see the Make.zsh file in the starter template.

You can use GitHub Actions to automatically build and deploy your site to GitHub Pages. See the example build.yml workflow file.