Public/blowfish

0 Fork 0

mirror of https://github.com/nunocoracao/blowfish.git synced 2026-10-10 22:09:31 +00:00

Files

T

Nour Agha bfc49a8e13 ✨ Add Ko-fi integration

2026-10-01 00:54:48 +03:00

12 KiB

Raw Permalink Blame History

Blowfish

Blowfish est conçu pour être un thème puissant et léger pour Hugo. Il est construit avec Tailwind CSS avec un design épuré et minimaliste qui donne la priorité à votre contenu.

🌏 Site de démonstration 📑 Documentation du thème 🐛 Rapports de bugs et problèmes 💡 Questions et demandes de fonctionnalités

Fonctionnalités

Disposition entièrement responsive construite avec Tailwind CSS 4
Plusieurs palettes de couleurs (ou personnalisez entièrement la vôtre)
Mode sombre (forcé activé/désactivé ou basculement automatique avec commutateur utilisateur)
Plusieurs mises en page pour la page d'accueil, y compris une page d'atterrissage de style produit avec image hero, statistiques et grilles de fonctionnalités
En-tête flottant effet verre avec raccourci de recherche ⌘K / Ctrl+K
Canevas d'arrière-plan global avec des sections hero qui s'y dissolvent au défilement
Barre de progression de lecture pour les articles
Sélecteur interactif de mise en page de la page d'accueil pour des aperçus en direct
Skill d'agent permettant aux agents de codage IA (comme Claude Code) d'installer et de configurer le thème pour vous
Pages adaptées à l'impression avec des styles d'impression dédiés
Configuration hautement personnalisable
Intégration Firebase pour prendre en charge les données dynamiques
Compteur de vues et mécanisme de likes
Articles connexes
Plusieurs auteurs
Séries d'articles
Tri des articles basé sur la date et le poids
Mode Zen pour la lecture d'articles
Flexible avec tous les types de contenu, taxonomies et menus
Menus d'en-tête et de pied de page
Menus imbriqués et menu de sous-navigation
Table des matières défilable
Support du contenu multilingue incluant la prise en charge des langues RTL
Possibilité de lier des articles sur des sites web tiers
Plus de 40 shortcodes incluant Gallery, Timeline, GitHub cards, Carousels, Stats, grilles de fonctionnalités, Steps et boutons CTA
Syntaxe GitHub Alerts, 15 types, support pliable
Intégration Buy Me a Coffee et Ko-fi
Recherche côté client alimentée par Fuse.js
Diagrammes et visualisations utilisant Mermaid
Graphiques utilisant Chart.js
Intégration TypeIt
Intégrations Youtube avec améliorations de performance
Notation mathématique utilisant KaTeX
Icônes SVG de FontAwesome 6
Redimensionnement automatique des images utilisant Hugo Pipes
Ancres de titres, Tables des matières, Copie de code, Boutons, Badges et plus
Support HTML et Emoji dans les articles 🎉
SEO optimisé avec liens pour partage sur les réseaux sociaux
Support de Fathom Analytics et Google Analytics
Flux RSS, Favicons et support des commentaires
Personnalisation avancée utilisant de simples définitions de couleurs et styles Tailwind
Optimisé pour les performances et l'accessibilité avec des scores Lighthouse parfaits
Entièrement documenté avec des mises à jour régulières

Documentation

Blowfish dispose d'une documentation complète qui couvre tous les aspects du thème. Assurez-vous de lire la documentation pour en savoir plus sur l'utilisation du thème et de ses fonctionnalités.

Installation

Blowfish prend en charge plusieurs méthodes d'installation - en tant que sous-module git, module Hugo, ou en tant qu'installation complètement manuelle.

Des instructions détaillées pour chaque méthode se trouvent dans la documentation Installation. Vous devriez consulter la documentation pour l'expérience de configuration la plus simple. Ci-dessous se trouve un guide de démarrage rapide utilisant les sous-modules si vous utilisez git, ou les modules Hugo si vous êtes déjà à l'aise avec l'installation de thèmes Hugo.

Démarrage rapide avec un agent IA

Blowfish inclut un agent skill qui apprend aux agents de codage IA — comme Claude Code — à installer, configurer et construire des sites avec le thème. Installez-le depuis la marketplace de plugins Blowfish dans Claude Code :

/plugin marketplace add nunocoracao/blowfish
/plugin install blowfish@blowfish

Ou copiez simplement le dossier du skill dans le dépôt de votre site à l'emplacement .claude/skills/blowfish/ — les agents détectent automatiquement les skills de projet. Demandez ensuite à votre agent de configurer Blowfish pour vous.

Démarrage rapide avec Blowfish Tools

Note : Assurez-vous d'avoir Node.js, Git et Hugo installés, et d'avoir créé un nouveau projet Hugo avant de continuer.

Blowfish Tools est un outil CLI qui vous aide à démarrer avec Blowfish. Il créera un nouveau projet Hugo, installera le thème et configurera les fichiers de configuration du thème pour vous. Veuillez signaler tout problème que vous rencontrez.

Installez l'outil CLI globalement en utilisant npm (ou un autre gestionnaire de paquets) :

npm i -g blowfish-tools

Ensuite, exécutez la commande blowfish-tools pour démarrer une exécution interactive qui vous guidera à travers les cas d'utilisation de création et de configuration.

blowfish-tools

Vous pouvez également exécuter la commande blowfish-tools new pour créer un nouveau projet Hugo et installer le thème en une seule fois. Consultez l'aide du CLI pour plus d'informations.

blowfish-tools new mynewsite

Démarrage rapide avec les sous-modules git

Note : Assurez-vous d'avoir Git et Hugo installés, et d'avoir créé un nouveau projet Hugo avant de continuer.

Depuis le répertoire de votre projet, initialisez git :
```
git init
```

Configurez Blowfish comme un sous-module git :

git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blowfish

Dans le dossier racine de votre site web, supprimez le fichier hugo.toml qui a été généré par Hugo. Copiez les fichiers de configuration *.toml du thème dans votre dossier config/_default/.

Vous trouverez ces fichiers de configuration du thème dans le répertoire cache de Hugo, ou téléchargez une copie depuis GitHub.
Suivez les instructions Pour commencer pour configurer votre site web.

Démarrage rapide avec Hugo

Note : Assurez-vous d'avoir Go et Hugo installés, et d'avoir créé un nouveau projet Hugo avant de continuer.

Depuis le répertoire de votre projet, initialisez les modules Hugo :
```
hugo mod init github.com/<username>/<repo-name>
```

Créez config/_default/module.toml et ajoutez ce qui suit :

[[imports]]
path = "github.com/nunocoracao/blowfish/v3"

Démarrez votre serveur en utilisant hugo server et le thème sera téléchargé automatiquement.
Dans le dossier racine de votre site web, supprimez le fichier hugo.toml qui a été généré par Hugo. Copiez les fichiers de configuration *.toml du thème dans votre dossier config/_default/.

Note : Ne remplacez pas le fichier module.toml que vous avez créé ci-dessus !

Vous trouverez ces fichiers de configuration du thème dans le répertoire cache de Hugo, ou téléchargez une copie depuis GitHub.
Suivez les instructions Pour commencer pour configurer votre site web.

Installation des mises à jour du thème

Au fur et à mesure que de nouvelles versions sont publiées, vous pouvez mettre à jour le thème en utilisant Hugo. Exécutez simplement hugo mod get -u depuis le répertoire de votre projet et le thème se mettra automatiquement à jour vers la dernière version.

Des instructions de mise à jour détaillées sont disponibles dans la documentation.

Mise à niveau de v2 vers v3

Blowfish v3 est entièrement rétrocompatible : chaque nouvelle fonctionnalité est optionnelle et aucune option de configuration ni aucun template n'a été supprimé. Les installations par sous-module git et manuelles se mettent à niveau comme d'habitude, sans aucun changement ; les utilisateurs de modules Hugo doivent simplement changer le chemin d'import dans config/_default/module.toml de github.com/nunocoracao/blowfish/v2 à github.com/nunocoracao/blowfish/v3 puis exécuter hugo mod get -u. Consultez les instructions de mise à niveau pour plus de détails.

Contribuer

Blowfish est destiné à évoluer au fil du temps. J'ai l'intention de continuer à ajouter des fonctionnalités et à apporter des modifications selon les besoins.

N'hésitez pas à me contacter pour tout problème ou suggestion de nouvelles fonctionnalités que vous aimeriez voir.

🐛 Rapports de bugs et problèmes : Utilisez GitHub Issues
💡 Idées de nouvelles fonctionnalités : Ouvrez une discussion sur GitHub Discussions
🙋‍♀️ Questions générales : Rendez-vous sur GitHub Discussions

Si vous êtes en mesure de corriger un bug ou de mettre en œuvre une nouvelle fonctionnalité, j'accueille les PR à cette fin. Apprenez-en plus dans les directives de contribution.

Mastodon

12 KiB Raw Permalink Blame History