Ajouter une bannière ASCII à un README GitHub
Placez-la dans un bloc de code Markdown et restez sous 80 colonnes.
Le nom d’un projet en bannière ASCII fait ressortir le haut d’un README. Contrairement à une image, c’est du texte brut : aucun fichier ajouté au dépôt, et un rendu correct en thème clair comme sombre.
L’ajouter à un README
En Markdown, la bannière doit se trouver dans un bloc de code. En dehors, les espaces répétés se réduisent à un seul, et _ et * deviennent des marqueurs d’italique et de gras, ce qui ruine l’art.
```text
_ _
_ __ ___ _ _ _ __ _ __ ___ (_) ___ ___| |_
| '_ ` _ \| | | |_____| '_ \| '__/ _ \| |/ _ \/ __| __|
| | | | | | |_| |_____| |_) | | | (_) | | __/ (__| |_
|_| |_| |_|\__, | | .__/|_| \___// |\___|\___|\__|
|___/ |_| |__/
```
# my-project
Un petit outil CLI à lancer directement depuis le terminal.
- Écrire
textaprès les accents graves d’ouverture désactive la coloration syntaxique : les caractères restent d’une seule couleur. - Ajoutez un vrai titre texte (
# my-project) sous la bannière. Moteurs de recherche et lecteurs d’écran ne lisent pas la bannière comme nom du projet. - Si l’art contient trois accents graves à la suite, entourez-le plutôt de quatre.
Rester sous 80 colonnes
Sur GitHub, un bloc de code défile horizontalement quand une ligne est trop longue. Une bannière coupée n’a plus d’intérêt : restez sous 80 colonnes, ou vers 50 pour qu’elle tienne aussi sur téléphone.
| Où on la lit | Largeur conseillée |
|---|---|
| README GitHub sur ordinateur | jusqu’à 80 colonnes |
| Appli GitHub, écrans étroits | environ 50 colonnes |
| Sortie de terminal | jusqu’à 80 colonnes |
Pour un nom long, choisissez une police plus petite comme Small ou Mini plutôt que Standard ou Big, ou coupez le nom sur deux lignes. Le coin supérieur droit de chaque carte de police de lab.ascii indique la largeur du résultat.
L’ajouter à un commentaire de code
Une bannière en haut d’un fichier, ou au début d’une grande section, aide à se repérer dans un long fichier.
/*
* ___ ___ _ _ ___ ___ ___
* | _ \ __| \| | \| __| _ \
* | / _|| .` | |) | _|| /
* |_|_\___|_|\_|___/|___|_|_\
*/
export function render() {}
- Commencez chaque ligne par le marqueur de commentaire (
*,//ou#). - Si l’art contient
*/, le commentaire de bloc s’arrête là. Utilisez des commentaires de ligne//pour cet art. - Si votre équipe impose une longueur de ligne, par exemple 100 caractères, faites tenir la bannière dedans.
L’afficher au lancement d’un programme
Pour afficher une bannière au démarrage d’un outil CLI, l’art doit être stocké dans une chaîne. Le problème, c’est la barre oblique inverse (\). Dans la plupart des langages, elle commence une séquence d’échappement : coller l’art tel quel fait perdre des caractères ou provoque une erreur.
En JavaScript, String.raw conserve les barres obliques inverses telles quelles.
const banner = String.raw`
_ _ ___ _ _ ___
| || | __| | | | / _ \
| __ | _|| |__| |_| (_) |
|_||_|___|____|____\___/
`;
console.log(banner);
Un accent grave ou ${ dans l’art termine la chaîne de gabarit. Il est généralement plus simple de changer de police pour cet art.
En Python, utilisez une chaîne brute en la préfixant de r.
BANNER = r"""
_ _ ___ _ _ ___
| || | __| | | | / _ \
| __ | _|| |__| |_| (_) |
|_||_|___|____|____\___/
"""
print(BANNER)
Une bannière de démarrage reste discrète si vous suivez deux règles.
- Ne l’affichez pas quand la sortie part vers un autre programme, comme un pipe ou un fichier journal.
- Proposez une option comme
--quietpour la désactiver.
Quelle police choisir ?
| Police | Caractère |
|---|---|
| Standard | Le choix sûr. Convient à tous les noms |
| Slant | Lettres penchées, impression de vitesse |
| Small | Un Standard plus petit. Bien pour les noms longs |
| Banner | Lettres massives remplies de #. La plus voyante |
| Digital | Une petite bannière de trois lignes, chaque lettre dans une case. Bien pour les commentaires de code |
Les 12 polices de lab.ascii n’utilisent que des caractères ASCII : elles restent intactes sur GitHub, dans les terminaux et dans les environnements anciens. Les bannières en caractères de bloc (█ ╗ ═) d’autres générateurs peuvent se casser dans des environnements très anciens ; si la bannière doit fonctionner partout, choisissez une police ASCII.
Tapez le nom de votre projet sur lab.ascii pour comparer des bannières dans 12 polices, puis cliquez sur une carte pour la copier.