Skip to content

Commit 15fbe0b

Browse files
committed
docs(en): favicons page
1 parent 9452b99 commit 15fbe0b

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

Diff for: docs/.vitepress/locales/en.ts

+1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ export default defineConfig({
3434
items: [
3535
{ text: 'Configuration', link: '/configuration' },
3636
{ text: 'Icons', link: '/icons' },
37+
{ text: 'Favicons', link: '/favicons' },
3738
],
3839
},
3940
{

Diff for: docs/reference/favicons.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Favicons
2+
3+
If you want to personalize your homepage with a unique logo, you have this option.
4+
You need to transfer a folder with your logos to the docker container.
5+
6+
## Logo creation
7+
8+
We suggest that you create an svg or png icon (if it is a png icon, then at the highest possible resolution) for your application and use it to create a favicon package in [Favicon Generator](https://realfavicongenerator.net/).
9+
10+
Once generated, download the ZIP and use the `android-*` icons for `pwa-*`:
11+
* `android-chrome-192x192.png``pwa-192x192.png`
12+
* `android-chrome-512x512.png``pwa-512x512.png`
13+
* `apple-touch-icon.png`
14+
* `favicon.ico`
15+
16+
## Using
17+
18+
Mount the new volume with the icons folder in your `docker-compose.yml` or pass the `-v` argument to docker run.
19+
20+
::: code-group
21+
```yaml [docker-compose.yml]
22+
version: '3.8'
23+
24+
services:
25+
mafl:
26+
image: hywax/mafl
27+
restart: unless-stopped
28+
ports:
29+
- '3000:3000'
30+
volumes:
31+
- ./config.yml:/app/data/config.yml
32+
- ./favicons:/app/public/favicons // [!code ++]
33+
```
34+
:::
35+
36+
File structure:
37+
38+
```text
39+
./favicons
40+
├── apple-touch-icon.png
41+
├── favicon.ico
42+
├── pwa-192x192.png
43+
└── pwa-512x512.png
44+
```

0 commit comments

Comments
 (0)