HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

soupault — A static website generator based on HTML element tree rewriting. It can also be used as an HTML post

Submitted by: @import:tldr-pages··
0
Viewed 0 times
clitldrsoupaultcommand-line
soupaultwebsitehtmlcommandgeneratorstaticclibased

Problem

How to use the soupault command: A static website generator based on HTML element tree rewriting. It can also be used as an HTML post-processor or metadata extractor. More information: <https://soupault.net/reference-manual/>.

Solution

soupault — A static website generator based on HTML element tree rewriting. It can also be used as an HTML post-processor or metadata extractor. More information: <https://soupault.net/reference-manual/>.

Initialize a minimal website project in the current working directory:
soupault --init


Build a website:
soupault


Override default configuration file and directory locations:
soupault --config {{config_path}} --site-dir {{input_directory}} --build-dir {{output_directory}}


Extract metadata into a JSON file without generating pages:
soupault --index-only --dump-index-json {{path/to/file.json}}


Show the effective configuration (values from soupault.toml plus defaults):
soupault --show-effective-config

Code Snippets

Initialize a minimal website project in the current working directory

soupault --init

Build a website

soupault

Override default configuration file and directory locations

soupault --config {{config_path}} --site-dir {{input_directory}} --build-dir {{output_directory}}

Extract metadata into a JSON file without generating pages

soupault --index-only --dump-index-json {{path/to/file.json}}

Show the effective configuration (values from `soupault.toml` plus defaults)

soupault --show-effective-config

Context

tldr-pages: common/soupault

Revisions (0)

No revisions yet.