docs: finition de la documentation

This commit is contained in:
Kazhnuz 2024-05-24 20:16:27 +02:00
parent 67826fcb9b
commit 5cff6fd48a

View file

@ -6,7 +6,18 @@ Embarcadère est une petite page simple que j'ai créé pour me servir de page d
Le site peut être modifié via le fichier `_data/config.json`, de la manière suivante.
## Ajouter des sites
## Customisation
Le site peut être customisé par trois moyens principaux : modifier l'image de fond, le favicon modifier la mascotte (et son texte/alt) et la couleur d'accents.
- Le fond peut être modifié en modifiant /public/img/background.jpg
- La couleur d'accent peut être modifié en modifiant le contenu de `accentColor` dans le fichier `_data/config.json`
- La mascotte peut être modifiée en modifiant /public/img/mascotte.png
- Son alt-text se trouve dans le fichier `_data/config.json` dans `mascotte.alt`
- Une description supplémentaire peut être trouvée dans le fichier `_data/config.json` dans `mascotte.message` et s'affichera au survol de la mascotte
- Le favicon peut être modifié en modifiant /public/favicon.png
## Modifié les sites
Les sites sont inclu dans les variables `featuredSites` ou dans des blocks dans la variable `siteBlocks`. Pour modifier les sites "mis en avant" (les boutons colorés), il vous suffit de modifier les sites qui sont géré de la manire suivante.
@ -29,6 +40,16 @@ Pour modifier les sites dans les blocks, vous pouvez le faire de la manière sui
]
```
Un lien supplémentaire `moreLink` peut également être modifié
```json
"moreLink": {
"nom": "Plus de liens sur mon shaarli !",
"url": "https://shaarli.kazhnuz.space",
"emoji": "🔗"
},
```
## Crédits
- Fond d'écran venant d'Elementary OS, fait par Ashim DSilva