1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-29 23:24:55 +02:00
tldr/pages/common/soupault.md
Lena 0fddee2272
pages/*: reword descriptions to comply with the style guide (#11507)
* pages/*: reword descriptions to comply with the style guide

---------

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-11-15 09:55:25 +05:30

703 B

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.app.

  • 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