Skip to content

rubenphilipp/colporter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

colporter

colporter is a static-site generator written in Common Lisp. Its HTML generation is able to take advantage of Spinneret (cf. tests/tests.lisp and examples/).

Tested with SBCL.

Usage notes

A tutorial is coming up soon. For now, refer to examples/ and the code documentation, available in doc/ or http://code.rubenphilipp.com/colporter.

Examples

The examples/ directory contains examples and a template to get started.

A real-world example is http://rubenphilipp.com which is created and maintained using colporter.

Project Structure

  • /src. Contains the source code of the project.
  • /doc. Contains a documentation generated via ROBODoc.
  • /tests. Regression tests via fiveam.
  • /examples. Example files for demonstration purposes.

Requirements

Lisp-wise

  • SBCL (or comparable)
    • currently, colporter is only tested on MacOS with SBCL
  • ASDF

Server

  • Apache 2 (for htaccess support, e.g. for custom error pages and mod_rewrite)

Nota Bene

As of August 2023, it is necessary to configure the web-server to redirect page requests to a file matching the output-suffix (e.g. “html”) given to make-colporter, as the links generated by colporter purposefully do not take into account the format used to eventually build the site into account. Anyway, this could be easily done (on an Apache server) by adding an .htaccess file to the root of the content/ (or similarly named) directory of the site. The examples/ explicate such approaches.

About

A Common Lisp static-site generator.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published