mkdocs.yml

This is a required setting, and should be a string that is used as 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

This config defines patterns of files (under docs_dir) to not be picked up into the built site. https://www.mkdocs.org/user-guide/configuration/#exclude_docs

This config defines patterns of files (under docs_dir) to be treated as a draft. Draft files are available during mkdocs serve and include a "DRAFT" mark but will not be included in the build. To prevent this effect and make "serve" behave the same as "build", you can run mkdocs serve --clean. https://www.mkdocs.org/user-guide/configuration/#draft_docs

If you want to include some docs into the site but intentionally exclude them from the nav, normally MkDocs warns about this. https://www.mkdocs.org/user-guide/configuration/#not_in_nav

Configure the strictness of MkDocs' diagnostic messages when validating links to documents. https://www.mkdocs.org/user-guide/configuration/#validation

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 (relative to docs_dir) to be included by the theme, typically as tags. 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, as