Haunt

Haunt is a simple, functional, hackable static site generator that gives authors the ability to treat websites as Scheme programs.

By giving authors the full expressive power of Scheme, they are able to control every aspect of the site generation process. Haunt provides a simple, functional build system that can be easily extended for this purpose.

Haunt has no opinion about what markup language authors should use to write posts, though it comes with support for the popular Markdown format. Likewise, Haunt has no opinion about how authors structure their sites. Though it comes with support for building simple blogs or Atom feeds, authors should feel empowered to tweak, replace, or create builders to do things that aren't provided out-of-the-box.

Usage

Here's what a simple Haunt configuration looks like:

(use-modules (haunt asset)
             (haunt builder blog)
             (haunt builder atom)
             (haunt builder assets)
             (haunt reader commonmark)
             (haunt site))

(site #:title "Built with Guile"
      #:domain "example.com"
      #:default-metadata
      '((author . "Eva Luator")
        (email  . "[email protected]"))
      #:readers (list commonmark-reader)
      #:builders (list (blog)
                       (atom-feed)
                       (atom-feeds-by-tag)
                       (static-directory "images")))

In a new directory, save the above to a file named haunt.scm.

Create subdirectories named posts and images.

Add the following to a new file named posts/hello.md:

title: First post!
date: 2018-03-13 18:00
tags: hello
summary: hello!
---

Hello, world!

Run haunt build to build the site.

Run haunt serve to a launch a web server to preview your work.

Open http://localhost:8080 in your web browser and smile, because you've just generated your first Haunt site!

Check out other sites built with Haunt over at awesome.haunt.page!

Documentation

View the reference manual

Releases

• 2024-02-19 — 0.3.0 — haunt-0.3.0.tar.gz — GPG signature
• 2022-01-26 — 0.2.6 — haunt-0.2.6.tar.gz — GPG signature
• 2021-04-15 — 0.2.5 — haunt-0.2.5.tar.gz — GPG signature
• 2018-11-29 — 0.2.4 — haunt-0.2.4.tar.gz — GPG signature
• 2018-11-25 — 0.2.3 — haunt-0.2.3.tar.gz — GPG signature
• 2018-03-10 — 0.2.2 — haunt-0.2.2.tar.gz — GPG signature
• 2017-01-23 — 0.2.1 — haunt-0.2.1.tar.gz — GPG signature
• 2016-04-24 — 0.2 — haunt-0.2.tar.gz — GPG signature
• 2015-08-08 — 0.1 — haunt-0.1.tar.gz — GPG signature

Requirements

• GNU Guile >= 2.0
• guile-commonmark (for Markdown support, optional)
• guile-reader (for Skribe support, optional)

Installation

To install Haunt with the GNU Guix package manager, run:

guix install haunt

To build and install Haunt from source, run:

wget https://files.dthompson.us/releases/haunt/haunt-0.3.0.tar.gz
tar xf haunt-0.3.0.tar.gz
cd haunt-0.3.0
./configure
make
make install

License

GNU GPLv3+

Git Repository

Haunt is developed using the Git version control system. The official repository is hosted at https://git.dthompson.us/haunt.git.

To clone the repository, run:

git clone https://git.dthompson.us/haunt.git

Community

Real-time discussion for Haunt can be found on the #guile channel on the Libera.chat IRC network

Contributing

Send patches and bug reports to [email protected].