
Settings
Settings Name | Default | Description |
---|---|---|
clean |
true |
remove old files from the site_dir before building |
site_dir |
none | directory to output the result of the documentation build, if also not set in config site is used |
directory_urls |
true |
use directory URLs when building pages |
config |
none | provide a specific MkDocs config |
strict |
false |
will cause MkDocs to abort the build on any warnings |
theme |
none | theme to use when building your documentation ([mkdocs |
verbose |
false |
enable verbose mode |
pip_install |
none | Add comma separated packages to be installed by pip before mkdocs is exec |