UStackUStack
shieldcn icon

shieldcn

shieldcn, alternative à shields.io, pour générer de superbes badges README au style shadcn/ui : GitHub, npm, Discord, thèmes, icônes et SVG personnalisés.

shieldcn

Qu'est-ce que shieldcn ?

shieldcn est un outil pour créer des « badges README magnifiques » en alternative à shields.io, avec un style de design similaire à shadcn/ui. Son objectif principal est d’aider les développeurs à générer du code de badges pour les README GitHub en utilisant des icônes prédéfinies et des options de badges configurables.

Le site propose un flux de création de badges où vous choisissez un type de badge, du texte lié au package, des options de variante et de style, et éventuellement uploadez des SVG personnalisés. Il génère un code de badge prêt à coller (ex. : syntaxe Markdown pour image) selon vos choix.

Fonctionnalités principales

  • Alternative à Shields.io avec qualité visuelle « shadcn/ui »
    • Le produit est positionné comme un générateur de badges alternatif avec un design spécifique.
  • Multiples variantes de badges (6)
    • Différentes approches visuelles ou de formatage disponibles dans le même système de badges.
  • Options de thèmes (16 thèmes)
    • Vous pouvez modifier l’apparence des badges au-delà de la sélection de variante de base.
  • Large ensemble d’icônes intégrées (plus de 5 000 icônes)
    • Choisissez parmi de nombreuses icônes prédéfinies pour composer vos badges.
  • Support SVG personnalisé avec combinaisons illimitées
    • Uploadez un SVG et combinez-le avec les options de badges pour générer des résultats personnalisés.
  • Paramètres de badges configurables
    • Le générateur prend en charge des réglages comme le type de badge, le package, la taille, le thème, le mode, l’icône, l’auto-upload, le format de police, le dégradé et les entrées de couleurs séparées par des virgules (avec un angle optionnel comme indiqué).

Comment utiliser shieldcn

  1. Ouvrez shieldcn et utilisez le générateur de badges (« Badge Builder »).
  2. Collez un dépôt GitHub (la page propose un flux « Essayez-le vous-même — collez un dépôt GitHub ») pour préremplir ou guider la sélection de badges.
  3. Choisissez votre type de badge, puis définissez des options comme le package, la variante, la taille, le thème et le mode.
  4. Sélectionnez une icône (de l’ensemble intégré) ou activez l’upload/auto-upload de SVG personnalisé si vous voulez utiliser votre propre icône.
  5. Configurez les options de style de sortie (par exemple, format de police et couleurs de dégradé si applicable).
  6. Copiez le code de badge généré (la page affiche une sortie Markdown comme ![badge](https://shieldcn.dev/npm/react.png)).

Cas d’utilisation

  • Générer des badges README cohérents pour un projet
    • Utilisez le générateur pour produire du code de badges GitHub README avec une taille, des thèmes et un style d’icônes cohérents.
  • Créer des badges pour packages ou npm
    • Sélectionnez un type de badge package et configurez variante/thème/style pour qu’il s’intègre à votre documentation.
  • Ajouter des icônes personnalisées aux badges pour des métadonnées spécialisées
    • Uploadez un SVG personnalisé et combinez-le avec les options de badges pour représenter des fonctionnalités ou catégories non couvertes par les icônes existantes.
  • Produire des ensembles de badges thématiques sur plusieurs dépôts
    • Utilisez les mêmes réglages de thème et de taille pour garder les badges visuellement cohérents lors de la maintenance de plusieurs dépôts.
  • Expérimenter avec des dégradés de couleurs pour la lisibilité des badges
    • Utilisez les entrées de couleurs de dégradé (valeurs hex séparées par des virgules, avec un angle optionnel) pour adapter les badges à l’identité visuelle du projet.

FAQ

  • Quels types de badges shieldcn supporte-t-il ?

    • La page mentionne des badges pour GitHub, npm et Discord, et le générateur inclut un réglage « type de badge ».
  • Puis-je utiliser ma propre icône pour un badge ?

    • Oui. Le générateur propose l’upload de SVG personnalisé (et une option « AutoUpload SVG » dans l’interface).
  • Comment copier le résultat dans mon README ?

    • Après configuration du générateur, copiez le code généré affiché sur la page (le site montre un exemple de syntaxe Markdown pour image).
  • shieldcn fournit-il des icônes intégrées ?

    • Oui. Il inclut plus de 5 000 icônes intégrées.
  • Y a-t-il un moyen de personnaliser les couleurs des badges ?

    • Oui. La page montre la configuration de dégradé avec des couleurs hex séparées par des virgules, avec un angle optionnel (format d’exemple inclus).

Alternatives

  • shields.io

    • Puisque shieldcn est explicitement décrit comme une alternative à shields.io, les utilisateurs cherchant une génération de badges de style shields.io sont la comparaison la plus directe ; la différence réside dans l'orientation de design visuel affirmée et les options de configuration supplémentaires offertes par shieldcn.
  • Générateurs de badges README avec templates personnalisables

    • D'autres outils de cette catégorie se concentrent sur la création d'URL de badges ou de templates pour les README ; ils diffèrent généralement par le degré de personnalisation visuelle/thèmes/icônes qu'ils proposent et par le support des téléchargements SVG personnalisés.
  • Outils de workflow icônes + SVG vers badges

    • Si vous avez principalement besoin d'icônes personnalisées sur des badges de documentation, les alternatives peuvent se centrer sur la conversion SVG/icônes puis l'association de ce résultat avec votre propre template de badge ou approche d'actif statique, plutôt que d'offrir un générateur dédié de badges README.
  • Systèmes de design de documentation pour badges

    • Certains projets utilisent des kits UI de documentation ou bibliothèques de composants pour créer des composants de badges stylisés ; ceux-ci diffèrent de l'approche de shieldcn, qui produit un markup de badges utilisable dans les README plutôt que des composants UI réutilisables pour une app en exécution.