Ratgeber
DE
한국어KOEnglishEN日本語JA简体中文ZHEspañolESPortuguês (Brasil)PTFrançaisFRDeutschDEРусскийRUBahasa IndonesiaIDहिन्दीHI

Alle Tools

Dev

Ein ASCII-Banner in eine GitHub-README einfügen

In einen Markdown-Codeblock setzen und unter 80 Spalten bleiben.

Zuletzt aktualisiert:

Ein Projektname als ASCII-Banner lässt den Anfang einer README hervorstechen. Anders als ein Bild ist es reiner Text: Es fügt dem Repository keine Datei hinzu und sieht im hellen wie im dunklen Theme richtig aus.

In eine README einfügen

In Markdown muss das Banner in einem Codeblock stehen. Außerhalb schrumpfen mehrere Leerzeichen zu einem, und _ und * werden zu Kursiv- und Fettmarkierungen, was die Art zerstört.

```text
                                       _           _
 _ __ ___  _   _       _ __  _ __ ___ (_) ___  ___| |_
| '_ ` _ \| | | |_____| '_ \| '__/ _ \| |/ _ \/ __| __|
| | | | | | |_| |_____| |_) | | | (_) | |  __/ (__| |_
|_| |_| |_|\__, |     | .__/|_|  \___// |\___|\___|\__|
           |___/      |_|           |__/
```

# my-project

Ein kleines CLI-Tool, das du direkt im Terminal startest.
  • text nach den öffnenden Backticks schaltet die Syntaxhervorhebung aus, die Zeichen bleiben einfarbig.
  • Setze eine echte Textüberschrift (# my-project) unter das Banner. Suchmaschinen und Screenreader können das Banner nicht als Projektnamen lesen.
  • Enthält die Art drei Backticks hintereinander, umschließe sie stattdessen mit vier.

Unter 80 Spalten bleiben

Ein Codeblock auf GitHub scrollt seitlich, wenn eine Zeile zu lang ist. Ein abgeschnittenes Banner verfehlt seinen Zweck, also bleib unter 80 Spalten, oder bei etwa 50, wenn es auch aufs Handy passen soll.

Wo es gelesen wird Empfohlene Breite
GitHub-README am Desktop bis 80 Spalten
GitHub-App, schmale Bildschirme etwa 50 Spalten
Terminalausgabe bis 80 Spalten

Wähle für einen langen Projektnamen eine kleinere Schrift wie Small oder Mini statt Standard oder Big, oder teile den Namen auf zwei Zeilen auf. Oben rechts auf jeder Schriftkarte von lab.ascii steht die Breite des Ergebnisses.

In einen Code-Kommentar einfügen

Ein Banner am Anfang einer Datei oder eines großen Abschnitts hilft, sich in langen Dateien zurechtzufinden.

/*
 *  ___ ___ _  _ ___  ___ ___
 * | _ \ __| \| |   \| __| _ \
 * |   / _|| .` | |) | _||   /
 * |_|_\___|_|\_|___/|___|_|_\
 */
export function render() {}
  • Beginne jede Zeile mit dem Kommentarzeichen (*, // oder #).
  • Enthält die Art */, endet der Blockkommentar dort. Nutze für solche Art //-Zeilenkommentare.
  • Gibt es im Team ein Zeilenlängenlimit, etwa 100 Zeichen, muss das Banner hineinpassen.

Beim Programmstart ausgeben

Um beim Start eines CLI-Tools ein Banner auszugeben, muss die Art als String gespeichert werden. Das Problem ist der Backslash (\). In den meisten Sprachen leitet er eine Escape-Sequenz ein, sodass beim unveränderten Einfügen Zeichen fehlen oder ein Fehler entsteht.

In JavaScript lässt String.raw Backslashes unverändert.

const banner = String.raw`
 _  _ ___ _    _    ___
| || | __| |  | |  / _ \
| __ | _|| |__| |_| (_) |
|_||_|___|____|____\___/
`;
console.log(banner);

Ein Backtick oder ${ in der Art beendet den Template-String. Meist ist es einfacher, für diese Art eine andere Schrift zu wählen.

In Python nutzt du einen Raw-String, indem du r davorsetzt.

BANNER = r"""
 _  _ ___ _    _    ___
| || | __| |  | |  / _ \
| __ | _|| |__| |_| (_) |
|_||_|___|____|____\___/
"""
print(BANNER)

Ein Startbanner stört nicht, wenn du zwei Regeln beachtest.

  • Gib es nicht aus, wenn die Ausgabe an ein anderes Programm geht, etwa in eine Pipe oder Logdatei.
  • Biete eine Option wie --quiet zum Abschalten an.

Welche Schrift passt?

Schrift Charakter
Standard Die sichere Wahl. Passt zu jedem Namen
Slant Schräge Buchstaben mit Tempo
Small Ein kleineres Standard. Gut für lange Namen
Banner Schwere, mit # gefüllte Buchstaben. Fällt am meisten auf
Digital Ein kleines dreizeiliges Banner, jeder Buchstabe in einem Kasten. Gut für Code-Kommentare

Alle 12 Schriften auf lab.ascii verwenden nur ASCII-Zeichen und bleiben daher auf GitHub, in Terminals und in älteren Umgebungen intakt. Banner aus Blockzeichen (█ ╗ ═) anderer Generatoren können in sehr alten Umgebungen kaputtgehen. Muss das Banner überall funktionieren, wähle eine ASCII-Schrift.

Tippe deinen Projektnamen auf lab.ascii ein, vergleiche Banner in 12 Schriften und klicke auf eine Karte, um sie zu kopieren.

Weitere Ratgeber