centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add hint about -f/--config-file in configuration documentation (#2616)

Browse Source
This commit is contained in:
Álvaro Mondéjar
2021-10-12 22:10:48 +02:00
committed by GitHub
parent 815af480d6
commit 8345850060
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/user-guide/configuration.md
View File

@@ -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.