LinuxCommandLibrary

soupault

HTML-native static site generator

TLDR

Build site

$ soupault
copy
Build with config
$ soupault --config [soupault.toml]
copy
Force rebuild
$ soupault --force
copy
Verbose output
$ soupault --verbose
copy
Show version
$ soupault --version
copy
Init project
$ soupault --init
copy

SYNOPSIS

soupault [--config file] [--force] [options]

DESCRIPTION

soupault is a static site generator and HTML processor that works directly with HTML files rather than using a template language. It takes plain HTML as input, manipulates the DOM tree using CSS selectors, and outputs modified HTML, making it compatible with any existing HTML content.
The tool uses a widget system configured in TOML to perform transformations like inserting content into pages, generating tables of contents, and adding metadata. Custom widgets can be written in Lua for project-specific processing needs.
Unlike most static site generators, soupault makes no assumptions about site structure or content format. It can process existing HTML sites without conversion, making it suitable for both new projects and migrating legacy websites.

PARAMETERS

--config FILE

Config file path.
--force
Force rebuild all.
--verbose
Verbose output.
--init
Initialize project.
--site-dir DIR
Site directory.
--build-dir DIR
Output directory.

CAVEATS

Learning curve unique. HTML-centric approach. OCaml written.

HISTORY

soupault was created as a site generator and HTML processor that works with real HTML rather than template languages.

SEE ALSO

hugo(1), jekyll(1), pandoc(1)

> TERMINAL_GEAR

Curated for the Linux community

Copied to clipboard

> TERMINAL_GEAR

Curated for the Linux community