Skip to content

create-config

create-config

Create a config based on a given build setup.

Runs the build script on given repository (either locally or a hosted one), infers the required resources (CSS / JS / Md extensions) as well as metadata and creates a MkDocs config file.

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

mknodes create-config [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 )

--theme, -t

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

-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.