Skip to content

SixArm/sita-rust-crate

Repository files navigation

Sita static site generator Rust crate

Sita is a static site generator.

Sita aims to be simple for simple needs, and flexible for complex needs.

Sita aims to be simpler than other static site generators, such as Astro, Eleventy, Jekyll, Hugo, Zola, etc.

Introduction

Sita aims to be simple for simple needs:

  • Sita uses simple default settings to get you up and running.

  • For example Sita can process one file from Markdown into HTML, without needing any special setup or any custom configuration.

Sita aims to be flexible for complex needs:

  • Sita uses more capabilities to integrate your work in more ways.

  • For example Sita can use front matter variables that can be set via HTML, JSON, TOML, YAML, XML, or other options.

Sita is currently being developed:

  • We welcome help and constructive feedback.

  • You can open a GitHub issue or contact us at sita@sixarm.com.

Sīta is a goddess

Sīta is an earth goddess who blesses the land with good crops. In the Vedic period, she was one of the goddesses associated with fertility. The word Sīta is a poetic term that signifies fertility and blessings coming from agriculture.

Getting started

--help

Get the Sita help introduction:

sita --help

--input / -i

Create a file example.md with this text:

hello world

Run Sita with an input file name:

sita --input example.md

The outcome is the file example.html with this text:

<p>hello world</p>

The --input option can handle multiple files, or directories, or globs.

--template / -t

Create a file template.html with this text:

<html>
  <body>
    {{{} content }}}
  </body>
</html>

Run Sita with a template file name:

sita --input example.md --template template.html

The result is the file example.html with this text:

<html>
  <body>
    <p>hello world</p>
  </body>
</html>

The --template option can handle multiple files, or directories, or globs.

Features

Features:

  • Compile from a typical Markdown file into a typical HTML web page.

  • Front matter can use HTML, JSON, TOML, YAML, or Markdown. More…

  • State variables can be set via matter or command line options. More…

Features that we may add in the future if people want to fund them:

  • Sections

  • Pagination

  • Taxonomies

  • Feeds

  • Sitemap

  • Robots.txt

  • 404 error page

  • Archive

Template engines

Sita is being developed to use multiple template engines.

The roadmap is:

  • Handlebars - because of speed and use by Rust ecosystem.

  • Liquid - because of popularity with e-commerce developers.

  • Tera - because of advanced capabilities and pure Rust.

About

Sita static site generator using Rust - WIP

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published