Merge pull request #3 from andreadistefano/fix_favicon-example-site

fix: use default favicon in custom site

README.md

@@ -61,9 +61,16 @@ git submodule update --remote --merge
 
 ### 🎨 Favicon
 
-Create `[SITEROOT]/layouts/partials/favicon.html` to override theme's favicon.
+In `config.toml`:
 
-If you want to use a simple emoji favicon, just copy the following code to your `favicon.html`:
+```toml
+[params]
+  replaceFavicon = true
+```
+
+Then, create `[SITEROOT]/layouts/partials/custom_favicon.html` to override the theme's default favicon.
+
+If you want to use a simple emoji favicon, just copy the following code to your `custom_favicon.html`:
 
 ```html
 <link
@@ -73,9 +80,8 @@ If you want to use a simple emoji favicon, just copy the following code to your
 ```
 See `layouts/partials/favicon.html` for an example.
 
-Otherwise, you can provide your favicon, or generate it using an online service, for example [realfavicongenerator.net](https://realfavicongenerator.net/). \
-See `exampleSite/layouts/partials/favicon.html` and `exampleSite\static\assets\favicon` for an example.
-
+Otherwise, you can provide your own favicon or generate it using an online service, for example [realfavicongenerator.net](https://realfavicongenerator.net/). \
+See `exampleSite/layouts/partials/custom_favicon.html` and `exampleSite/static/assets/favicon` for an example.
 
 ### ❌ License, toc and comments
 

exampleSite/config.toml

@@ -53,6 +53,9 @@ summaryLength = 100 # Custom summary length, add <!--more--> in post file to cus
   # Copyright
   copyrightStartYear = "2024"
 
+  # favicon
+  replaceFavicon = false
+
   # Open Graph & Twitter Card variables
   # You can also set description and images in post front matter individually
   description = "A minimal Hugo theme with nice theme color."

layouts/partials/head.html

@@ -8,7 +8,11 @@
 {{ hugo.Generator }}
 
 <!-- favicon -->
+{{ if .Site.Params.replaceFavicon }}
+{{ partial "custom_favicon.html" . }}
+{{ else }}
 {{ partial "favicon.html" . }}
+{{ end }}
 <!-- seo metadata -->
 {{ if and (.IsHome) (.Site.Params.subTitle) }}
 <title>{{ .Site.Title }} - {{ .Site.Params.subTitle }}</title>