Command-line options
Command-line options vary by subcommand and include -o to set the path of the output file; -m to set the path of the source Markdown directory (./src or ./drafts by default, depending on the subcommand); -c to set the path to the directory containing the Cargo.toml that declares the dependencies (Rust crates) used in your book; and -t to set the path to the destination directory.
-y is a global option that skips confirmation dialogs and is useful when calling mdbook-utils from a script. Commands that modify your Markdown files ask for confirmation first; without a terminal (for example in a script or CI) they fail with an error and change nothing unless -y is given.
--log <LEVEL> is a global option to set the logging level (error, warn, info, debug, trace). It trumps the RUST_LOG environment variable.
Use mdbook-utils <command> <subcommand> --help or help <command> <subcommand> for more details.
The following illustrates options for mdbook-utils sitemap:
Generate a sitemap.xml file from published HTML pages in SUMMARY.md
Usage: mdbook-utils sitemap [OPTIONS]
Options:
-m, --markdown-dir <DIR> Source directory containing the source Markdown files
-b, --base-url <URL> Base URL
-o, --output <FILE> Path of the file to create
--map-index <FROM:TO> Map a filename to another (e.g., 'intro.md' to 'index.md')
-y, --yes Automatically answer `yes` to any user confirmation request
--log <LOG> Set the logging level (error, warn, info, debug, trace) [env: RUST_LOG=]
-h, --help Print help
The sitemap destination must be inside an existing HTML renderer output directory, such as the configured mdBook build directory. A page is listed only when it appears in SUMMARY.md and its rendered HTML file exists in that output directory.