docs: plus de doc
All checks were successful
continuous-integration/drone Build is passing

This commit is contained in:
Kazhnuz 2024-05-25 09:32:30 +02:00
parent 0675ec968f
commit df263bfafd

View file

@ -1,10 +1,21 @@
# Embarcadère
Embarcadère est une petite page simple que j'ai créé pour me servir de page d'accueil sur mes navigateurs web. Son principe est d'être un simple "embarcadère" vers les différents sites auquel j'ai besoin d'accéder. Elle ne contient pas de fonctionnalités fancy comme afficher l'heure (mon OS fait ça), la météo (mon OS fait ça) ou lire des flux RSS (j'ai un lecteur de flux pour ça).
Embarcadère est le code de Kobold Start, un petit portail que j'ai créé pour Kobold Cafe (qui me sert de page d'accueil sur mes névigateur web).
## Modifier la page
Son principe est d'être un simple "embarcadère" vers les différents sites auquel j'ai besoin d'accéder. Elle ne contient pas de fonctionnalités fancy comme afficher l'heure (mon OS fait ça), la météo (mon OS fait ça) ou lire des flux RSS (j'ai un lecteur de flux pour ça).
Le site peut être modifié via le fichier `_data/config.json`, de la manière suivante.
Le dépot contient le code tel qu'il est utilisé pour Kobold Cafe, et donc des éléments associés, mais vous pouvez le modifier pour créer votre propre portail.
## Fonctionnalités
- Une barre de recherche vers DuckDuckGo
- Affichez une liste de site qui vous intéresse, aisément modifiable via le fichier `_data/config.json`
- Différenciation entre des liens mis en avant et par catégorie + un lien "plus de site".
- Un style simple et neutre, mais où vous pouvez
- Modifier la couleur d'accent dans la configuration
- Modifier le fond et le favicon
- Afficher une mascotte pour plus de fun !
- Utilisation d'emoji afin de rajouter un peu de vie à la liste des sites
## Customisation
@ -12,10 +23,10 @@ Le site peut être customisé par trois moyens principaux : modifier l'image de
- 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
- 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
- Le favicon peut être modifié en modifiant `/public/favicon.png`
## Modifié les sites
@ -50,6 +61,21 @@ Un lien supplémentaire `moreLink` peut également être modifié
},
```
## Tester & compiler
Pour tester le site, il vous faut npm et npx sur votre installation, et utiliser la commande
```
npx @11ty/eleventy --serve
```
Vous pouvez build le site avec
```
npm build
```
## Crédits
- Fond d'écran venant d'Elementary OS, fait par Ashim DSilva
- La mascotte de Kobold Café par Withelias