Übersicht
Diese Seite dokumentiert die GitHub-spezifischen Assets für kieks.me Repositories. Diese Assets helfen dabei, ein konsistentes Branding über alle GitHub-Repositories hinweg zu gewährleisten.
README Header
Banner-Grafik für die obere Seite von README.md Dateien mit kieks.me Branding.
- • Format: SVG / PNG
- • Größe: 1200x200px
- • Brand-konform
README Template
Wiederverwendbares Template für README.md Dateien in anderen kieks.me Repositories.
- • Standard-Sektionen
- • Footer mit Branding
- • Anpassbare Variablen
Social Preview
Vorschaubild für Social Media (GitHub, Twitter, etc.) mit 40pt Safe Area Border.
- • Format: SVG / PNG
- • Größe: 1280x640px
- • GitHub-konform
README Header
Der README Header ist eine Banner-Grafik, die am Anfang von README.md Dateien verwendet werden kann, um ein professionelles Branding zu gewährleisten.
Verwendung
Füge den Header am Anfang deiner README.md ein:
Spezifikationen
- Abmessungen: 1200x200px
- Format: SVG (vektorisiert) und PNG (rasterisiert)
- Hintergrund: Navy (#1E2A45)
- Logo: kieks.me horizontal (Aqua)
- Schriftart: Hanken Grotesk (Überschriften)
Beispiel-Banner (Samples)
Hier findest du Beispiel-Banner für verschiedene Repository-Typen. Diese zeigen, wie der README Header für unterschiedliche Projekte aussehen kann.
Eigene Banner generieren
Du kannst eigene README Header Banner mit dem folgenden Befehl generieren:
pnpm generate:readme-header:samplesDas Script generiert Beispiel-Banner für verschiedene Repository-Typen. Du kannst das Script anpassen, um eigene Titel und Designs zu erstellen.
README Template
Das README Template bietet eine Standard-Struktur für README.md Dateien in kieks.me Repositories. Es enthält alle wichtigen Sektionen und einen Footer mit Branding.
Template-Struktur
- Header mit Logo und Branding
- Projekt-Titel und Beschreibung
- Badges (Version, License, etc.)
- Installation
- Verwendung
- Contributing
- License
- Footer mit kieks.me Branding
Verwendung
Das Template befindet sich unter:
assets/templates/README_TEMPLATE.mdKopiere das Template in dein Repository und ersetze die Platzhalter-Variablen (z.B. {{REPO_NAME}}, {{DESCRIPTION}}) mit deinen spezifischen Informationen.
Social Preview
Das Social Preview Image wird von GitHub verwendet, um eine Vorschau des Repositories in Social Media Posts und auf anderen Plattformen anzuzeigen.
Setup
Um das Social Preview Image zu verwenden:
-
Kopiere die Datei
.github/social-preview.pngin dein Repository -
Stelle sicher, dass die Datei im
.githubVerzeichnis liegt - GitHub erkennt die Datei automatisch und verwendet sie als Social Preview
Spezifikationen
- Abmessungen: 1280x640px (empfohlen für beste Darstellung)
- Minimum: 640x320px
- Format: PNG oder SVG
- Safe Area: 40pt Border (wichtig für GitHub)
- Hintergrund: Navy (#1E2A45)
- Logo: kieks.me horizontal (Aqua)
Hinweis: Wichtige Inhalte sollten innerhalb der 40pt Safe Area bleiben, um sicherzustellen, dass nichts abgeschnitten wird.
Dokumentation
Detaillierte Anleitungen und Dokumentationen für alle GitHub Assets findest du in den folgenden Dateien: