Add an option to specify a custom favicon #16

Closed
wants to merge 2 commits into
from

Conversation

Projects
None yet
3 participants
@kcgthb

kcgthb commented Mar 14, 2016

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

extra:
  favicon: favicon.ico

kcgthb added some commits Mar 14, 2016

Allow specifying a custom favicon
Add an extra setting to specify a custom favicon:
```
extra:
  favicon: favicon.ico
```
Merge pull request #1 from kcgthb/kcgthb-favicon
Allow specifying a custom favicon
@squidfunk

This comment has been minimized.

Show comment
Hide comment
@squidfunk

squidfunk Mar 14, 2016

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.

Owner

squidfunk commented Mar 14, 2016

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

This comment has been minimized.

Show comment
Hide comment
@squidfunk

squidfunk Mar 14, 2016

Owner

Fixed in master, will be part of 0.2.2

Owner

squidfunk commented Mar 14, 2016

Fixed in master, will be part of 0.2.2

@squidfunk squidfunk added the bug label Mar 14, 2016

@squidfunk squidfunk added this to the 0.2.2 milestone Mar 14, 2016

@kcgthb

This comment has been minimized.

Show comment
Hide comment
@kcgthb

kcgthb 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

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

This comment has been minimized.

Show comment
Hide comment
@d0ugal

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

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

This comment has been minimized.

Show comment
Hide comment
@squidfunk

squidfunk Mar 14, 2016

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.

Owner

squidfunk commented Mar 14, 2016

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.

@squidfunk squidfunk referenced this pull request Mar 20, 2016

Closed

Favicon option is ignored #22

tomashley added a commit to outlyerapp/support that referenced this pull request Feb 27, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment