flex-template-web/docs/icons.md
2018-12-05 11:07:47 +02:00

47 lines
2 KiB
Markdown

# Icons
The default icons are generated with [RealFaviconGenerator](https://realfavicongenerator.net/). You
can upload your original icon to the tool, customize the colors and themes, and download a generated
set if icons and an HTML snippet to point to those images.
1. Open https://realfavicongenerator.net/
1. Upload your original icon image
1. Configure platform specific icons
**Note:** Remember to set the "Theme color" in the Android Chrome section
1. Configure the paths to use `/static/icons/` as the root path of the icons
1. Generate the icons
1. Unzip the favicons.zip archive and replace the default icons and files in
[public/static/icons/](../public/static/icons/) with the new icons
1. Replace the default HTML snippet in [public/index.html](../public/index.html) with the snippet
from the generator.
**Note:** Remove the manifest link from the snippet as we have a default manifest with extra
data compared to the generated one. You can edit the default file as you wish.
**Example HTML snippet:**
```html
<!-- Start Favicons from https://realfavicongenerator.net/ -->
<link rel="apple-touch-icon" sizes="180x180" href="/static/icons/apple-touch-icon.png" />
<link rel="icon" type="image/png" sizes="32x32" href="/static/icons/favicon-32x32.png" />
<link rel="icon" type="image/png" sizes="16x16" href="/static/icons/favicon-16x16.png" />
<link rel="mask-icon" href="/static/icons/safari-pinned-tab.svg" color="#c0392b" />
<link rel="shortcut icon" href="/static/icons/favicon.ico" />
<meta name="msapplication-config" content="/static/icons/browserconfig.xml" />
<meta name="theme-color" content="#c0392b" />
<!-- End Favicons -->
```
## Map marker icon
The map marker icon in the listing can be found in
[src/components/Map/images/marker-32x32.png](../src/components/Map/images/marker-32x32.png). The
dimensions should be 32x32 pixels, so the `favicon-32x32.png` file can be used to replace the map
icon.