Fixed favicon regression caused by deprecation upstream

CHANGELOG

@@ -1,6 +1,7 @@
 mkdocs-material-2.x.x (2017-xx-xx)
 
   * Fixed #553: meta title and description only renders first character
+  * Fixed favicon regression caused by deprecation upstream
 
 mkdocs-material-2.0.1 (2017-10-31)
 

docs/getting-started.md

@@ -343,6 +343,16 @@ extra:
   [17]: https://lunrjs.com
   [18]: https://github.com/MihaiValentin/lunr-languages
 
+### Favicon
+
+The default favicon can be changed by setting the `favicon` variable to an
+`.ico` or image file:
+
+``` yaml
+theme:
+  favicon: 'images/favicon.ico'
+```
+
 ### Features
 
 #### Tabs
@@ -360,15 +370,6 @@ theme:
 
 ## Customization
 
-### Adding a favicon
-
-A favicon can be added by setting the `site_favicon` variable to an `.ico` or
-image file:
-
-``` yaml
-site_favicon: 'images/favicon.ico'
-```
-
 ### Adding a source repository
 
 To include a link to the repository of your project within your documentation,

material/base.html

@@ -33,11 +33,7 @@
       ] %}
         <meta name="lang:{{ key }}" content="{{ lang.t(key) }}">
       {% endfor %}
-      {% if config.site_favicon %}
-        <link rel="shortcut icon" href="{{ base_url }}/{{ config.site_favicon }}">
-      {% else %}
-        <link rel="shortcut icon" href="{{ base_url }}/assets/images/favicon.png">
-      {% endif %}
+      <link rel="shortcut icon" href="{{ base_url }}/{{ config.theme.favicon }}">
       <meta name="generator" content="mkdocs-{{ mkdocs_version }}, mkdocs-material-2.0.1">
     {% endblock %}
     {% block htmltitle %}

material/mkdocs_theme.yml

@@ -36,6 +36,8 @@ font:
   text: Roboto
   # Fixed-width font for code listings
   code: Roboto Mono
+# Favicon to be rendered
+favicon: assets/images/favicon.png
 # The logo of the documentation shown in the header and navigation can either
 # be a Material Icon ligature or an image URL
 logo:

mkdocs.yml

@@ -51,6 +51,7 @@ theme:
   font:
     text: Roboto
     code: Roboto Mono
+  favicon: assets/images/favicon.png
   logo:
     icon: school
 

src/base.html

@@ -73,13 +73,8 @@
       {% endfor %}
 
       <!-- Favicon -->
-      {% if config.site_favicon %}
       <link rel="shortcut icon"
-            href="{{ base_url }}/{{ config.site_favicon }}">
-      {% else %}
-        <link rel="shortcut icon"
-            href="{{ base_url }}/assets/images/favicon.png">
-      {% endif %}
+          href="{{ base_url }}/{{ config.theme.favicon }}">
 
       <!-- Generator banner -->
       <meta name="generator"

src/mkdocs_theme.yml

@@ -49,6 +49,9 @@ font:
   # Fixed-width font for code listings
   code: Roboto Mono
 
+# Favicon to be rendered
+favicon: assets/images/favicon.png
+
 # The logo of the documentation shown in the header and navigation can either
 # be a Material Icon ligature or an image URL
 logo: