12 releases

0.2.3 Aug 4, 2023
0.2.2 Jul 22, 2023
0.1.0 Jul 3, 2023
0.0.7 Jun 26, 2023
0.0.2 Feb 6, 2022

#167 in Command line utilities

Download history 4/week @ 2024-02-24 2/week @ 2024-03-09 1/week @ 2024-03-16 62/week @ 2024-03-30 13/week @ 2024-04-06

64 downloads per month

GPL-3.0-or-later

60KB
861 lines

pipeline status crates.io

Kobold

Kobold is a static site generator with a friendly CLI.

Usage: kobold <COMMAND>

Commands:
  init   Create a new Kobold project in the specified directory
  build  Generate website from the Kobold project at the specified directory
  help   Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Installation

You can install Kobold via Cargo:

cargo install kobold-ssg

As long as Cargo's bin directory ($HOME/.cargo/bin by default) is in your PATH, you are set.

Alternatively you can clone the repository and then use:

cargo run --release -- [kobold commands, options]

Quick start

Create a new Kobold project:

kobold init koboldsite.com

This creates the koboldsite.com/ directory and initializes it as a git repository with the directory structure that Kobold requires:

koboldsite.com/
├── content/
│   └── index.md
├── layouts/
│   └── default.html
├── macros/
│   └── ...
└── css/
    └── ...

The project can contain more sub-directories with other names, but sub-directories site/ and site.old/ are reserved for usage by Kobold.

If you have used any other static site generator, you can probably guess how Kobold works based on this directory structure.

The index.md file is the main page of the website, and starts with the following contents:

---
title: Home page
---

# Hello Kobold!

You can already generate a website:

kobold build koboldsite.com

That command creates a site/ sub-directory in the koboldsite.com/ directory with the generated website. You can visit the website with your favorite web browser:

firefox koboldsite.com/site/index.html

or start an HTTP server, e.g.:

cd koboldsite.com/site && python -m http.server

You can then work on your website by adding more files under content/.

Files with the .md extension are processed to:

  1. evaluate macros (if any)
  2. convert Markdown into HTML
  3. apply the desired page layout (by default, default.html)

All other files under content/ are copied into site/ as they are, with the same directory structure. The css/ directory is also copied into site/ as-is.

Custom page layouts can be added to the layouts directory: they are Tera templates and they must have the .html extension. Placeholders such as {{title}} and {{body}} in the layouts are substituted with appropriate values during the website generation (see context variables).

To select a custom page layout add layout: filename to the page's frontmatter (omitting the .html extension).

Page frontmatter

Markdown content pages (that is, text files with the .md extension in the content/ directory) may start with a YAML frontmatter. This is a snippet of YAML enclosed between two lines that only contain ---. If present, it contains metadata that will inform the page processing.

The following keys in the frontmatter have a special meaning for Kobold:

  • title: the page title
  • layout: the layout to use for this page. In order to use layout blog_post.html, use layout: blog_post (omitting the extension)
  • tags: an array of tags that will be attached to this page, e.g. [c++, war-stories]

Any other keys will be made available as context variables during site generation.

Generating content with macros

Tera macros can be used to automate the generation of page content. In a Kobold project they are files that live in the macros/ directory (no sub-directories are allowed) and can have any extension (e.g. .md, .html or .tera).

Usage from Markdown content pages

Macros are the only Tera feature that can be used in content pages. They are automatically made available under the macros namespace (no need to {% import %} them) and can be invoked as:

{{ macros::macroname(parameter="value") }}

Remember that Tera macros require the usage of keyword arguments. The macro invocation is replaced by the output of its evaluation before the Markdown is converted to HTML.

Usage from layouts

Differently from Markdown content pages, layouts are full-blown Tera templates, so macros work as they usually do in Tera (and they are not automagically imported):

{% import '../macros/mymacrofile.html' as somemacros %}

{{ somemacros::macroname(parameter="value") }}

For both layouts and content pages, context variables can be passed to macros as parameters.

Tera context variables

The following variables are made available to the templates in layouts/ as well as when evaluating macros in Markdown content pages:

  • title: the page title as stated in the YAML frontmatter
  • path: the page URL relative to the website root /
  • tags: the tags attached to the page
  • data: a map containing any extra variables that were set in the page's frontmatter
  • pages: an array of Page{title, path, tags, layout, data} that contains the corresponding info for all the content pages of the site
  • body (only in layouts, not in content pages): the page body, with macros already evaluated and converted to HTML

Roadmap

  • human-friendly error messages that are prescriptive rather than descriptive whenever possible
  • support for programmatic generation of page content via Tera macros
  • automatic syntax highlighting for code blocks
  • nice autocompletion for the fish shell
  • make the body of pages selected via the needs key in the frontmatter available as part of the Tera context

Why?

I wanted a personal website and I wanted to practice my Rust.

Kobold was written from scratch, but it has many similarities to the more mature Zola and Cobalt. Kobold lacks many of their features, but in exchange it tries to be so easy to use that you can start working on your website without reading any docs, just playing with the kobold command.

I also appreciate Hugo's focus on speed and its no-nonsense workflow, and shortcodes make a lot of sense so Kobold's macros try to replicate some of that usefulness.

Not a static site generator per se, but Sylvain Kerkour's Building a static site generator in 100 lines of Rust was a great resource to get me started.

Contributing

If you happen to try out Kobold, any feedback is more than welcome.

Contributions in the form of issues or patches are even more appreciated.

Dependencies

~16–28MB
~426K SLoC