Bruno Charest
721d53025a
docs: update theme configuration instructions with simplified JSON format and add Docker command example. ```
93 lines
3.5 KiB
Markdown
93 lines
3.5 KiB
Markdown
# Shaarli BC Theme (Professional)
|
||
|
||
> Thème moderne pour [Shaarli](https://github.com/shaarli/Shaarli), pensé pour une expérience professionnelle, responsive et compatible modes clair/sombre.
|
||
|
||
## Présentation
|
||
|
||
- **Nom interne :** Professional
|
||
- **Version :** 1.0.0
|
||
- **Auteur :** Antigravity
|
||
- **Dossier :** `tpl/shaarli-pro`
|
||
|
||
Le thème fournit un layout type application avec barre latérale fixe, navigation fluide, focus sur l’accessibilité et une couche JavaScript dédiée aux interactions.
|
||
|
||
## Fonctionnalités principales
|
||
|
||
1. **Mode clair/sombre natif** avec mémorisation du choix utilisateur.
|
||
2. **Sidebar intelligente** : navigation compacte sur desktop, menu escamotable sur mobile.
|
||
3. **Recherche “Spotlight”** en surimpression : raccourci `S`, navigation au clavier, surlignage des résultats.
|
||
4. **Filtres rapides** pour isoler liens publics, privés ou non tagués.
|
||
5. **Variables CSS centralisées** pour personnaliser palette, ombres, typographies.
|
||
|
||
## Compatibilité et prérequis
|
||
|
||
- Shaarli ≥ 0.9 (sélection du thème depuis *Tools > Configure your Shaarli*).
|
||
- Accès en écriture au répertoire `tpl/`.
|
||
- Possibilité de modifier `data/config.json.php` pour les installations plus anciennes.
|
||
|
||
## Installation
|
||
|
||
1. **Télécharger** ce dépôt ou récupérer uniquement `shaarli-pro/` via la page des releases.
|
||
```bash
|
||
git clone https://git.dracodev.net/Projets/Shaarli_bm_theme.git
|
||
```
|
||
2. **Copier** le dossier `shaarli-pro/` dans `tpl/` à côté du dossier `default/`.
|
||
```bash
|
||
docker cp "./shaarli-pro" myshaarli:/var/www/shaarli/tpl/
|
||
```
|
||
3. **Vérifier les droits** (lecture par l’utilisateur du serveur web).
|
||
```bash
|
||
docker exec -it myshaarli chown -R www-data:www-data /var/www/shaarli/tpl/
|
||
```
|
||
|
||
## Activation
|
||
|
||
### Via l’interface (recommandé)
|
||
1. Connectez-vous à Shaarli en tant qu’administrateur.
|
||
2. Ouvrez **Tools > Configure your Shaarli**.
|
||
3. Choisissez **Professional (shaarli-pro)** dans la liste des thèmes.
|
||
4. Sauvegardez, puis rafraîchissez la page d’accueil.
|
||
|
||
### Activation manuelle (Shaarli < 0.9)
|
||
Ajoutez ou mettez à jour `data/config.json.php` :
|
||
|
||
```json
|
||
{
|
||
"resource": {
|
||
"theme": "shaarli-pro"
|
||
}
|
||
}
|
||
```
|
||
ou utiliser cette commande docker
|
||
```bash
|
||
docker exec -it myshaarli sed -i 's/"theme": "default"/"theme": "shaarli-pro"/' /var/www/shaarli/data/config.json.php
|
||
```
|
||
|
||
Redémarrez votre service PHP si nécessaire et videz le cache navigateur.
|
||
|
||
## Configuration & personnalisation
|
||
|
||
- **Palette et typographies** : modifiez les variables dans `shaarli-pro/css/style.css` ou surchargez-les proprement via `data/user.css`.
|
||
- **Comportements front** : adaptez `shaarli-pro/js/script.js` (toggle thème, recherche, filtres, sidebar).
|
||
- **CSS/JS personnalisés** : placez vos ajouts dans `data/user.css` ou créez un template additionnel (`extra.html`) pour de futurs scripts.
|
||
|
||
## Structure utile
|
||
|
||
- `shaarli-pro/css/style.css` : styles principaux et variables.
|
||
- `shaarli-pro/js/script.js` : interactions (mode sombre, recherche, filtres, sidebar mobile).
|
||
- `shaarli-pro/*.html` : templates RainTPL couvrant toutes les vues Shaarli.
|
||
- `example_Shaarli-Material/` : thème hérité servant d’exemple/sandbox.
|
||
|
||
## Mise à jour
|
||
|
||
1. Sauvegardez vos données (`data/`) et vos surcharges.
|
||
2. Remplacez le dossier `tpl/shaarli-pro/` par la nouvelle version.
|
||
3. Purgez les caches navigateur/OPcache.
|
||
|
||
## Support
|
||
|
||
- Ouvrez une issue GitHub en joignant captures et logs.
|
||
- Indiquez vos versions (Shaarli, thème, plugins activés) pour faciliter le diagnostic.
|
||
|
||
Bon partage de liens !
|