2025-03-14 21:59:59 -06:00
|
|
|
# soupault
|
|
|
|
|
|
|
|
|
|
> A static website generator based on HTML element tree rewriting.
|
|
|
|
|
> It can also be used as an HTML post-processor or metadata extractor.
|
2025-12-16 10:20:31 -07:00
|
|
|
> More information: <https://soupault.net/reference-manual/>.
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Initialize a minimal website project in the current working directory:
|
|
|
|
|
|
|
|
|
|
`soupault --init`
|
|
|
|
|
|
|
|
|
|
- Build a website:
|
|
|
|
|
|
|
|
|
|
`soupault`
|
|
|
|
|
|
|
|
|
|
- Override default configuration file and directory locations:
|
|
|
|
|
|
2025-12-16 10:20:31 -07:00
|
|
|
`soupault --config {{config_path}} --site-dir {{input_directory}} --build-dir {{output_directory}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- 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`
|
