Go to file

David Thompson 1ddcff389d Add support for Skribe document format. * haunt/skribe.scm: New file. * haunt/skribe/utils.scm: New file. * haunt/reader/skribe.scm: New file. * configure.ac: Check for guile-reader. * Makefile.am (SOURCES): Add Skribe modules when guile-reader is available. * example/haunt.scm: Include Skribe reader. * example/posts/baz.skr: New file. * README.md ("Requirements"): Mention guile-reader as optional dependency.		2015-10-12 20:22:28 -04:00
example	Add support for Skribe document format.	2015-10-12 20:22:28 -04:00
haunt	Add support for Skribe document format.	2015-10-12 20:22:28 -04:00
scripts	Remove hardcoded Guile executable path.	2015-07-26 15:20:18 -04:00
website	website: Add license information to home page.	2015-08-10 09:06:04 -04:00
.gitignore	Include example and website directories in release tarballs.	2015-08-10 09:04:42 -04:00
COPYING	First commit.	2015-01-04 20:02:16 -05:00
Makefile.am	Add support for Skribe document format.	2015-10-12 20:22:28 -04:00
README.md	Add support for Skribe document format.	2015-10-12 20:22:28 -04:00
THANKS	Add THANKS file.	2015-08-09 10:13:18 -04:00
bootstrap	Add autotools bootstrap script.	2015-07-19 10:02:53 -04:00
configure.ac	Add support for Skribe document format.	2015-10-12 20:22:28 -04:00
package.scm	Update Guix development package.	2015-08-08 09:58:59 -04:00
pre-inst-env.in	First commit.	2015-01-04 20:02:16 -05:00

README.md

Haunt

About

Haunt is a static site generator written in Guile Scheme. It's simple, functional, and extensible.

Features

Easy blog and Atom feed generation
Supports any markup language that can be parsed to SXML
Simple development server
Purely functional build process
User extensible

Example Configuration

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

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

Usage

Write a configuration file named haunt.scm. Add your posts to a directory named posts. Then run haunt build!

To view your creation, run haunt serve and browse to localhost:8080.

Requirements

GNU Guile >= 2.0.11

Optional:

guile-reader (for Skribe support)

Building from Git

Haunt uses the familiar GNU build system. GNU automake, autoconf, and make are required to build from a git checkout.

./bootstrap && ./configure && make

Once Haunt is built, it can be run directly from the source tree (no need to run make install) via the pre-inst-env script:

./pre-inst-env haunt --help

GNU Guix users can create a build environment with all necessary dependencies using the handy guix environment tool:

guix environment -l package.scm

Examples

An example Haunt site can be found in the example directory:

cd example
../pre-inst-env haunt build

License

GNU GPLv3 or later