build

build

Create a MkNodes-based website, locally or remotely.

Runs the build script on given repository (either locally or a hosted one), adapts the config file automatically and creates the HTML website in given site dir.

Further info here: https://phil65.github.io/mkdocs-mknodes/CLI/

mknodes build [OPTIONS]

--repo-url, -r

Repository URL of the target package. Can be remote or local.

--build-fn, -b

Path to the build script. (form: path.to.module:function )

--site-dir, -d

Default: site Path to the folder where the HTML should get written.

--clone-depth, -c

Git clone depth in case repository is remote. Important for changelog generation.

--config-path, -p

Default: mkdocs.yml Path to the config file.

--theme, -t

Default: material Theme to use for the build. Overrides config setting.

--strict, -s

:mdi-flag: Flag Strict mode (fails on warnings)

-u, --use-directory-urls

Default: True :mdi-flag: Flag Use directory-style URLs.

--verbose, -v

:mdi-flag: Flag Enable verbose output. (DEBUG level)

--quiet, -q

:mdi-flag: Flag Suppress output during build.

--help

:mdi-flag: Flag Show this message and exit.