From bc0ce9b419ed271babad1e9d126fc7a2fd7ac3e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Mond=C3=A9jar=20Rubio?= Date: Tue, 12 Oct 2021 12:52:58 +0200 Subject: [PATCH 1/2] Add hint about `-f/--config-file` in configuration documentation --- docs/user-guide/configuration.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md index 7c48869837..6a635f4e8a 100644 --- a/docs/user-guide/configuration.md +++ b/docs/user-guide/configuration.md @@ -6,8 +6,9 @@ Guide to all available configuration settings. ## Introduction -Project settings are always configured by using a YAML configuration file in the -project directory named `mkdocs.yml`. +Project settings are configured by default using a YAML configuration file in +the project directory named `mkdocs.yml`. You can specify another path for it +by using the `-f/--config-file` option (see `mkdocs build --help`). As a minimum, this configuration file must contain the `site_name` and `site_url` settings. All other settings are optional. From b59780d9c7ea398766af7331651fca6f25948db6 Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Tue, 12 Oct 2021 22:07:41 +0200 Subject: [PATCH 2/2] Update docs/user-guide/configuration.md --- docs/user-guide/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md index 6a635f4e8a..d7da01eaa6 100644 --- a/docs/user-guide/configuration.md +++ b/docs/user-guide/configuration.md @@ -8,7 +8,7 @@ Guide to all available configuration settings. Project settings are configured by default using a YAML configuration file in the project directory named `mkdocs.yml`. You can specify another path for it -by using the `-f/--config-file` option (see `mkdocs build --help`). +by using the `-f`/`--config-file` option (see `mkdocs build --help`). As a minimum, this configuration file must contain the `site_name` and `site_url` settings. All other settings are optional.