![Forrest logo](/images/logo.png)
soupault:tldr:73ef1
The command soupault --init
initializes a new Soupault project or sets up a configuration file for an existing project.
Soupault is a static site generator and web scraper designed for building and maintaining static websites. It allows users to generate web pages automatically based on HTML templates, apply transformations to the HTML structure, and scrape websites to update or patch content. By using soupault --init
, you can set up a directory structure and configuration file for your Soupault project.
When you run soupault --init
, it performs the following steps:
- Creates a new directory or uses the existing one as the root directory of your project.
- Sets up a configuration file named
soupault.conf
in the project directory. This file allows you to configure various aspects of your Soupault project, such as input/output directories, template settings, crawler options, etc. - Initializes any necessary subdirectories, such as
input
andoutput
, which will hold the input files and generated output files, respectively.
After running soupault --init
, you can start customizing your project by modifying the soupault.conf
file and creating your input files (HTML, templates, etc.) in the appropriate directories. Then, when you run Soupault commands such as soupault --build
, it will use the configuration and input files to generate the output files based on your specifications.