Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from Oct 12, 2021
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc0ce9b
Add hint about `-f/--config-file` in configuration documentation
mondeja Oct 12, 2021
b59780d
Update docs/user-guide/configuration.md
oprypin Oct 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/user-guide/configuration.md
View file
Open in desktop
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