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 an option to specify a custom favicon #16

Closed
wants to merge 2 commits into from
Closed

Add an option to specify a custom favicon #16

wants to merge 2 commits into from

Conversation

kcgthb
Copy link
Contributor

@kcgthb kcgthb commented Mar 14, 2016

Add an extra setting in mkdocs.yml to specify a custom favicon:

extra:
  favicon: favicon.ico

Add an extra setting to specify a custom favicon:
```
extra:
  favicon: favicon.ico
```
Allow specifying a custom favicon
@squidfunk
Copy link
Owner

Basically, this functionality is already provided by MkDocs:
http://www.mkdocs.org/user-guide/configuration/#site_favicon

However, the template refers to icon, not favicon in the template, so correcting this would be the right way to go. I will close this pull request and provide a fix instantly.

@squidfunk
Copy link
Owner

Fixed in master, will be part of 0.2.2

@squidfunk squidfunk added the bug Issue reports a bug label Mar 14, 2016
@squidfunk squidfunk added this to the 0.2.2 milestone Mar 14, 2016
@kcgthb
Copy link
Contributor Author

kcgthb commented Mar 14, 2016

Thanks.
Except it looks like the MkDocs devs defer to theme customization for this an plan to remove the site_favicon entirely: mkdocs/mkdocs#725

@d0ugal
Copy link

d0ugal commented Mar 14, 2016

Yeah, it's weird having a setting for something so small and specific. We won't remove it for some time tho' - no idea when 1.0 will happen and we will want to have a clear migration path.

@squidfunk
Copy link
Owner

Well, it depends. I think the favicon is something like the name of your project, so for me it makes sense to be part of the core MkDocs configuration. However, the favicon is only one of many customization options. You also would want to configure og:image and a web application icon for iOS, so maybe it makes sense to leave it up to the theme.

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

Successfully merging this pull request may close these issues.

None yet

3 participants