staticbolt

Build fast static websites.

Example:

staticbolt build
staticbolt serve

Options:

--cwd <directory> optional

The directory to run in. Works with every command.

--config <path> optional

The config file, relative to the directory. Works with every command. Defaults to ".staticbolt.ts".

--help, -h optional

Show this help message.

--version, -v optional

Show current version.

Subcommands:

help <command>

Print help message for a specific command.

Example:

staticbolt help build

Arguments:

command optional

The command to get help for.

build, b

Build static website command.

Options:

--outdir <directory> optional

The output directory, absolute or relative to the project root.

--measure optional

Measure per-plugin hook execution time and print a report after the build.

dev, d

Start the dev server: build on demand, watch, and reload the browser.

Options:

--host optional

Listen on every address, so the site is reachable from other devices on the network.

--port <number> optional

The port.

--entry <pathname> optional

The pathname of the URL to open.

serve, preview

Serve the built output, to check a production build before shipping it.

Example:

staticbolt serve --port 8080 --host

Options:

--port, -p <number> optional

The port to listen on.

default: 4000

--host optional

Listen on every address, so the site is reachable from other devices on the network.

default: false

--dir, -d <path> optional

The directory to serve. Defaults to the configured output directory.

--single, -s optional

Answer unknown paths with index.html, for a single page application.

default: false

--cors optional

Send Access-Control-Allow-Origin: * with every response.

default: false

--compress optional

Compress responses. On by default, turn it off with --no-compress.

default: true

convert-fonts, woff2

Convert TTF fonts to WOFF2 format.

Options:

--fonts <pattern>

A glob pattern to match font files.

--exclude <pattern> optional

A glob patterns to exclude input files.

--out-dir, -o <path>

Where to save the output files.

fontface, font

Generate @font-face rules for all fonts and save it to css file.

Options:

--fonts <pattern>

A glob pattern to match font files.

--exclude <pattern> optional

A glob patterns to exclude input files.

--css-out, -o <path>

Where to save the output CSS file.

--font-display <auto|block|swap|fallback|optional> optional

The font display property.

default: "swap"

palette, material-you

Generate and print Material You palette.

Example:

staticbolt palette --color "#ff0000" --style SPRITZ --raw > palette.css

Options:

--color, -c

The seed color to generate the palette. only HEX color is supported.

--style, -s optional

The style of the palette.

default: "TONAL_SPOT"

--format, -f optional

The output format.

default: "css"

--raw, -r optional

Print without highlighting.

default: false