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 rule to favicon optimisation #6183

Merged
merged 13 commits into from
Aug 7, 2023
Binary file added rules/optimise-your-favicon/bad-favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added rules/optimise-your-favicon/good-favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions rules/optimise-your-favicon/rule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
type: rule
archivedreason:
title: Do you optimise your website favicon?
guid: df8d34e2-89c9-4a97-be6c-70f473890bdd
uri: optimise-your-favicon
jackreimers marked this conversation as resolved.
Show resolved Hide resolved
created: 2023-07-28T12:00:00.0000000Z
authors:
- title: Jack Reimers
url: https://ssw.com.au/people/jack-reimers
related:
-
---

Favicons are commonplace in web development, but did you know your favicon may not be properly optimised for all devices?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer answering the question (rule title) in the intro, and then going into more detail after


<!--endintro-->

## What is a Favicon?

Favicons are most commonly used to display a custom icon on a browser tab, but they can also be used to alter the display of your website in other cases.

Some places the favicon is used are:
- Browser Tabs
- Android and iPhone Icons
- Windows and Mac Icons
jackreimers marked this conversation as resolved.
Show resolved Hide resolved

## How to Check Your Favicon

Even if your website has a favicon, it may not be fully compliant.
You can use [realfavicongenerator.net](https://realfavicongenerator.net/favicon_checker) to check your website.

::: bad
![Figure: Bad example - Favicon does not display properly on all devices](bad-favicon.png)
:::

::: good
![Figure: Bad example - Favicon displays properly on all devices](good-favicon.png)
:::

## How to Update Your Favicon

[realfavicongenerator.net](https://realfavicongenerator.net) also has a favicon generator that you can use to generate a set of icons and meta tags from a single image.

The site will guide you through all the settings and display a preview of how your favicon will look on each device.
![Figure: Choosing our favicon settings](favicon-generator.png)

Once you're happy with how it looks, click `Generate your Favicons and HTML code` and you will be given instructions on how to install your new favicon with a number of popular technologies, such as HTML5, ASP.NET Core and NodeJS.
Loading