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.

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

Add site_name to example mkdocs.yml #281

Closed
wants to merge 1 commit into from

Conversation

mattbostock
Copy link
Contributor

site_name is a required field, so include it in the example.

`site_name` is a required field, so include it in the example.
@squidfunk
Copy link
Owner

The Material documentation states that you already have a working MkDocs project. It is not intended to fix you up with MkDocs. The docs clearly state:

Add the following line to your mkdocs.yml

site_name might end up being redundant in mkdocs.yml. We could add a notice in the Getting started guide, but no one ever complained about this, so I would favor to keep it short.

@mattbostock
Copy link
Contributor Author

I misread that line to mean 'create an mkdocs.yml file with the following content', I guess because the pip package for Material pulls in mkdocs itself and I was following the README as a new user of Mkdocs (finding a good theme played an important part in my decision to use Mkdocs).

So feasibly you might follow the README as a new Mkdocs user and be confused why it complains about site_name (as I did).

That said I can understand that you don't wish to duplicate the documentation for Mkdocs.

@mattbostock mattbostock deleted the patch-1 branch April 21, 2017 22:52
@mattbostock
Copy link
Contributor Author

Closed in favour of a smaller change:
#289

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants