Skip to content

Commit

Permalink
Add hint about -f/--config-file in configuration documentation (#2616)
Browse files Browse the repository at this point in the history
  • Loading branch information
mondeja committed Oct 12, 2021
1 parent 815af48 commit 8345850
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/user-guide/configuration.md
Expand Up @@ -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.
Expand Down

0 comments on commit 8345850

Please sign in to comment.