Getting started

How to install #

npm install -g

The command lighthouse should be available after the installation.

How to run #

lighthouse [--flags] [input-path] [input-file]

Alternatively, this can be used:

npm run build && node ./target/app.js [--flags] [input-path] [input-file]

Run arguments #

Argument Description Default value
input-path Optional. Tells Lighthouse where is the source directory to generate the site Current directory
input-file Optional. Relative path inside source of the file to process. Useful when you have a working site and you want to update only one file without having to process the whole site All files are processed

Run parameters #

Parameter Description Default value
--minify Optional. Enables the minification of generated files, if disabled a prettier formatter is used false
--debug Optional. Enables debug mode to show not found variables and files messages on generated files, also generates intermediate MD files while processing and shows more information on the logs false
keyboard_double_arrow_upBack to top