mkdocs.yml

The main title for the project documentation. https://www.mkdocs.org/user-guide/configuration/#site_name

Set the canonical URL of the site. This will add a link tag with the canonical URL to the head section of each HTML page. If the 'root' of the MkDocs site will be within a subdirectory of a domain, be sure to include that subdirectory in the setting (https://example.com/foo/). https://www.mkdocs.org/user-guide/configuration/#site_url

When set, provides a link to your repository (GitHub, Bitbucket, GitLab, ...) on each page. https://www.mkdocs.org/user-guide/configuration/#repo_url

When set, provides the name for the link to your repository on each page. https://www.mkdocs.org/user-guide/configuration/#repo_name

The path from the base repo_url to the docs directory when directly viewing a page, accounting for specifics of the repository host (e.g. GitHub, Bitbucket, etc), the branch, and the docs directory itself. https://www.mkdocs.org/user-guide/configuration/#edit_uri

The more flexible variant of edit_uri. https://www.mkdocs.org/user-guide/configuration/#edit_uri_template

Set the site description. This will add a meta tag to the generated HTML header. https://www.mkdocs.org/user-guide/configuration/#site_description

Set the name of the author. This will add a meta tag to the generated HTML header. https://www.mkdocs.org/user-guide/configuration/#site_author

Set the copyright information to be included in the documentation by the theme. https://www.mkdocs.org/user-guide/configuration/#copyright

Set the remote branch to commit to when using gh-deploy to deploy to GitHub Pages. This option can be overridden by a command line option in gh-deploy. https://www.mkdocs.org/user-guide/configuration/#remote_branch

Set the remote name to push to when using gh-deploy to deploy to GitHub Pages. This option can be overridden by a command line option in gh-deploy. https://www.mkdocs.org/user-guide/configuration/#remote_name

This setting is used to determine the format and layout of the global navigation for the site. https://www.mkdocs.org/user-guide/configuration/#nav

Sets the theme and theme specific configuration of your documentation site. https://www.mkdocs.org/user-guide/configuration/#theme

The directory containing the documentation source markdown files. This can either be a relative directory, in which case it is resolved relative to the directory containing your configuration file, or it can be an absolute directory path from the root of your local file system. https://www.mkdocs.org/user-guide/configuration/#docs_dir

The directory where the output HTML and other files are created. This can either be a relative directory, in which case it is resolved relative to the directory containing your configuration file, or it can be an absolute directory path from the root of your local file system. https://www.mkdocs.org/user-guide/configuration/#site_dir

Set a list of CSS files in your docs_dir to be included by the theme. For example, the following example will include the extra.css file within the css subdirectory in your docs_dir. https://www.mkdocs.org/user-guide/configuration/#extra_css

Set a list of JavaScript files in your docs_dir to be included by the theme. See the example in extra_css for usage. https://www.mkdocs.org/user-guide/configuration/#extra_javascript

Set a list of templates in your docs_dir to be built by MkDocs. To see more about writing templates for MkDocs read the documentation about [custom themes] and specifically the section about the [available variables] to templates. See the example in extra_css for usage. https://www.mkdocs.org/user-guide/configuration/#extra_templates

A set of key-value pairs, where the values can be any valid YAML construct, that will be passed to the template. This allows for great flexibility when creating custom themes. https://www.mkdocs.org/user-guide/configuration/#extra

Determines additional directories to watch when running mkdocs serve. https://www.mkdocs.org/user-guide/configuration/#watch

This setting controls the style used for linking to pages within the documentation. https://www.mkdocs.org/user-guide/configuration/#use_directory_urls

Determines how warnings are handled. Set to true to halt processing when a warning is raised. Set to false to print a warning and continue processing. https://www.mkdocs.org/user-guide/configuration/#strict

Determines the address used when running mkdocs serve. Must be of the format IP:PORT. https://www.mkdocs.org/user-guide/configuration/#dev_addr

This setting lets you enable a list of extensions beyond the ones that MkDocs uses by default (meta, toc, tables, and fenced_code). https://www.mkdocs.org/user-guide/configuration/#markdown_extensions

A list of paths to Python scripts (relative to mkdocs.yml) that are loaded and used as plugin instances. https://www.mkdocs.org/user-guide/configuration/#hooks

A list of plugins (with optional configuration settings) to use when building the site. See the Plugins documentation for full details. https://www.mkdocs.org/user-guide/configuration/#plugins

Define the parent for a configuration file. The path must be relative to the location of the primary file. https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance