-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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.
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
Allow mkdocs.yaml when '--config' is not passed #2206
Conversation
If you like this PR I would appreciate when you add the |
Interesting patch. While I understand why some might want this, I'm not sure I like the idea. The file extension is clearly documented. So just use the correct extension. I'll have to think about this. In any event, at a minimum, this would need a note added to the release notes. |
Of course, I added a line to the release notes. Hope this is the correct way to do so. |
There is a conflict you need to resolve. You should have rebased against master prior to adding the note. Then you could have added the note to the new (under development) section of the release notes which has recently been added. |
I resolved the conflict already. |
Agreed that the documentation is clear enough. :) The problem in our case (https://github.com/backstage/backstage) is that most of the other YAML files have |
We wanted to give our colleagues to possibility to build docs automatically when they put a
mkdocs.yml
in the docs folder of their repository. But it happened often, that they used.yaml
instead the.yml
.When this PR is accepted, it will look first look for
mkdocs.yml
when--config
is not provided. If this file is not present, it will try to findmkdocs.yaml
.When both are not present, it behaves like before.
When both are present, it behaves like before.
If only the
.yaml
version it present, this one will be used as the config file.