diff --git a/pages/common/soupault.md b/pages/common/soupault.md new file mode 100644 index 000000000..ebeac9baa --- /dev/null +++ b/pages/common/soupault.md @@ -0,0 +1,25 @@ +# soupault + +> Soupault is 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: . + +- Initialize a minimal website project in the current working directory: + +`soupault --init` + +- Build a website: + +`soupault` + +- Override default config file and directory locations: + +`soupault --config {{config_path}} --site-dir {{input_dir}} --build-dir {{output_dir}}` + +- Extract metadata into a JSON file without generating pages: + +`soupault --index-only --dump-index-json {{path/to/file.json}}` + +- Show the effective config (values from `soupault.toml` plus defaults): + +`soupault --show-effective-config`