NAME

Statickle - static site generator in a Tcl file: download, unpack, run!

SYNOPSIS

make-sta.tcl [-?] [-v] [-q] [-f CONFIG] [-o DEST] [-n LIMIT]

DESCRIPTION

Statickle is a static site generator intended as a blog engine. It takes any number of posts in Markdown format with YAML front matter (one post per file) and outputs them as a static web pages, along with an index file, newsfeed and archive for each year and tag. The resulting website can be hosted on any web server, or browsed offline.

The HTML output is generated based on a configuration file and several templates; usable defaults should be included along with the program.

Statickle is written in Tcl, using tcllib, and needs both to work.

OPTIONS

-?, -help

Show a list of command-line options with brief explanations, then exit.

-v

Show current version number and exit without doing anything else.

-q

Don't print the usual confirmation messages. Any error messages are still printed. Useful for scripting.

-f CONFIG

Use given configuration file. Default is config.yaml in the current directory.

-o DEST

Export to given folder instead of the current working directory. Will be created if it doesn't exist already.

-n LIMIT

Recent items to show on the front page and in the newsfeed (default: 10).

EXIT STATUS

code 0

Statickle completed successfully.

code 1

An unrecognized command-line option was given.

code 2

Loading the configuration file failed.

code 3

Statickle is missing a theme file.

code 4

The output directory doesn't exist and can't be created.

FILES

To begin with, Statickle needs a configuration file; by default it looks for config.yaml in the current directory. The configuration format is outside the scope of this document, but a sample should be included with the program.

For proper operation, Statickle also needs a theme directory (theme by default), containing at a minimum the following template files:

archive.html

Used for the year and tag archives.

index.html

Used only for the index page.

page.html

Used for the blog's static pages, if any.

post.html

Used for each individual blog post.

summary.html

Used for each of the post summaries on the index page.

If any of these files is missing, the program exits with an error.

VERSIONS

This manual applies to release 1.2 (August 2020) of Statickle.

AUTHORS

Statickle is written by Felix Pleşoianu.

LICENSE

This software is open source under the MIT License. Use at your own risk.

SEE ALSO

BashBlog, the original inspiration for Statickle.

Pelican, a more powerful SSG in Python and another source of inspiration.