doc: un peu de dock pour la documentation

This commit is contained in:
Kazhnuz 2024-05-24 17:44:11 +02:00
parent e3f7c23636
commit 57a98914e7

View file

@ -4,12 +4,31 @@ Embarcadère est une petite page simple que j'ai créé pour me servir de page d
## Modifier la page
- La page HTML contient toute les données, les liens et les éléments utilisable.
- Pour changer le moteur de recherche, il suffit de remplacer l'action et le "name" du champ de recherche
- Les icones utilisable sont [trouvable ici](https://forkaweso.me/Fork-Awesome/icons/)
- Les couleurs sont modifiable via les variable css utilisées.
Le site peut être modifié via le fichier `_data/config.json`, de la manière suivante.
## Ajouter des 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.
```json
"featuredSites":[
{"nom":"<nom qui sera affiché sur le bouton>", "url":"<url du site>", "emoji":"<Un emoji à utiliser>"},
]
```
Pour modifier les sites dans les blocks, vous pouvez le faire de la manière suivante
```json
"siteBlocks":[
{
"nom":"<nom du block>",
"sites":[
{"nom":"<nom qui sera affiché sur le lien>", "url":"<url du site>", "emoji":"<Un emoji à utiliser>"},
]
},
]
```
## Crédits
- Icones par fork-awesome
- Fond d'écran venant d'Elementary OS, fait par Ashim DSilva