14 KiB
GitHub Readme Stats
Zeige dynamisch generierte GitHub-Statistiken in deinen Readmes!
Beispiel ansehen · Fehler melden · Funktion wünschen
Français · 简体中文 · Español · Deutsch · 日本語 · Português Brasileiro · Italiano · 한국어
Du magst das Projekt? Wie wäre es mit einer kleinen Spende um es weiterhin am Leben zu erhalten?
Funktionen
- GitHub Statistiken-Karte
- GitHub Extra Pins
- Top Programmiersprachen-Karte
- Erscheinungsbild/Themes
- Anpassungen/Personalisierung
- Selber betreiben
GitHub Statistiken-Karte
Kopiere einfach folgendes in dein Markdown und das wars. Echt simpel!
Passe den Wert des URL-Parameters ?username=
so an, dass dort dein GitHub Nutzername steht.
[![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
Hinweis: Die Berechnung des Ranges basiert auf den jeweiligen Benutzerstatistiken, siehe src/calculateRank.js
Verbergen individueller Statistiken
Um eine spezifische Statistik auszublenden, kann dem Query-Parameter ?hide=
ein Array an Optionen, die nicht angezeigt werden sollen, übergeben werden.
Optionen:
&hide=stars,commits,prs,issues,contribs
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","prs"])
Symbole anzeigen
Um Symbole anzuzeigen kann der URL-Paramter show_icons=true
wie folgt verwendet werden:
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)
Erscheinungsbild/Themes
Mithilfe der eingebauten Themes kann das Aussehen der Karten verändern werden ohne manuelle Anpassungen vornehmen zu müssen.
Benutze den ?theme=THEME_NAME
-Parameter wie folgt :-
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical)
Alle eingebauten Themes :-
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
Du kannst dir eine Vorschau aller verfügbaren Themes ansehen oder die theme config Datei ansehen.
Außerdem kannst du neue Themes beisteuern, Beiträge sind gern gesehen :D
Anpassungen/Personalisierung
Du kannst das Erscheinungsbild deiner Stats Card
oder Repo Card
, mithilfe von URL-Parametern, nach deinen Vorlieben anpassen.
Verbreitete Optionen:
title_color
- Titelfarbe (hex color)text_color
- Textkörperfarbe (hex color)icon_color
- Symbolfarbe (falls verfügbar) (hex color)bg_color
- Hintergrundfarbe (hex color) oder ein Farbverlauf in der Form von winkel,start,endetheme
- Name des Erscheinungsbildes/Themes alle verfügbaren Themescache_seconds
- manuelles festlegen der Cachezeiten (min: 1800, max: 86400)
Farbverlauf in bg_color
Du kannst mehrere, mit Kommas separierte, Werte in der bg_color Option angeben, um einen Farbverlauf anzuzeigen. Das Format ist:-
&bg_color=WINKEL,FARBE1,FARBE2,FARBE3...FARBE10
Hinweis bzgl. des Caches: Wenn die Anzahl der Forks und Stars geringer als 1 Tsd ist, haben die Repo-Cards eine Standard-Cachezeit von 30 Minuten (1800 Sekunden), ansonsten beträgt diese 2 Stunden (7200 Sekunden). Außerdem ist der Cache auf ein Minimum von 30 Minuten und ein Maximum von 24 Stunden begrenzt.
Exklusive Optionen der Statistiken-Karte:
hide
- Verbirgt die angegeben Elemente (mit Komma abgegrenzte Werte)hide_title
- (boolean)hide_rank
- (boolean)hide_border
- (boolean)show_icons
- (boolean)include_all_commits
- Zähle alle Beiträge anstatt nur das aktuelle Jahr (boolean)count_private
- Zähle private Beiträge (boolean)line_height
- Legt die Zeilenhöhe zwischen Text fest (Zahl)
Exklusive Optionen der Repo-Karte:
show_owner
- Zeigt den Besitzer des Repos (boolean)
Exklusive Optionen der Sprachen-Karte:
hide
- Verbirgt die angegebenen Sprachen von der Karte (Komma separierte Werte)hide_title
- (boolean)hide_border
- (boolean)layout
- Wechsel zwischen den zwei verfügbaren Layoutsdefault
&compact
card_width
- Lege die Breite der Karte manuell fest (Zahl)
⚠️ Wichtig:
Sprachennamen sollten uri-escaped sein, wie hier angegeben: Percent Encoding
(z.B.:c++
sollte zuc%2B%2B
werden,jupyter notebook
sollte zujupyter%20notebook
werden, usw.)
GitHub Extra Pins
GitHub extra pins ermöglicht es mit Hilfe einer Readme auf deinem Profil mehr als 6 Repositories anzuzeigen.
Und Bääm! Du bist nicht mehr auf 6 angeheftete Repositories limitiert.
Benutzung
Füge diesen Code in deine Readme-Datei ein und passe die Links an.
Endpunkt: api/pin?username=anuraghazra&repo=github-readme-stats
[![ReadMe Card](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats)](https://github.com/anuraghazra/github-readme-stats)
Beispiele
Benutze die show_owner Variable, um den Nutzernamen des Repo Eigentümers anzuzeigen.
Top Programmiersprachen-Karte
Die Top Programmiersprachen Card visualisiert die am meisten benutzten Programmiersprachen eines GitHub-Nutzers.
HINWEIS: Die Top Programmiersprachen treffen keine Aussage über persönliche Fähigkeiten oder dergleichen, es ist lediglich eine auf den GitHub-Statistiken des Nutzers basierende Kennzahl, welche Programmiersprache wie häufig verwendet wurde.
Benutzung
Füge diesen Code in deine Readme-Datei ein und passe die Links an.
Endpunkt: api/top-langs?username=anuraghazra
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
Verbirg einzelne Sprachen
Du kannst den ?hide=language1,language2
URL-Parameter benutzen, um einzelne Sprachen auszublenden.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html)](https://github.com/anuraghazra/github-readme-stats)
Kompaktes Sprachen-Karte Layout
Du kannst die &layout=compact
Option nutzen, um das Karten Design zu ändern.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats)
Beispiel
- Kompaktes Layout
Alle Beispiele
- Default
- Ausblenden bestimmter Statistiken
- Symbole anzeigen
- Alle Beiträge anzeigen
- Erscheinungsbild/Themes
Wähle Eines von den Standard-Themes
- Farbverlauf
- Statistiken-Karte anpassen
- Repo-Karte anpassen
- Top Programmiersprachen
Kleiner Tipp (Ausrichten der Repo-Karte)
Üblicherweise ist es in .md
-Dateien nicht möglich Bilder nebeneinander anzuzeigen. Um dies zu erreichen kann folgender Ansatz gewählt werden:
<a href="https://github.com/anuraghazra/github-readme-stats">
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" />
</a>
<a href="https://github.com/anuraghazra/convoychat">
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
</a>
Betreibe es auf deiner eigenen Vercel-Instanz
Check Out Step By Step Video Tutorial By @codeSTACKr
Da die GitHub API nur 5 Tsd Aufrufe pro Stunde zulässt, kann es passieren, dass meine https://github-readme-stats.vercel.app/api
dieses Limit erreicht.
Wenn du es auf deinem eigenen Vercel-Server hostest, brauchst du dich darum nicht zu kümmern. Klicke auf den Deploy-Knopf um loszulegen!
Hinweis: Seit #58 sollte es möglich sein, mehr als 5 Tsd Aufrufe pro Stunde ohne Downtimes zu verkraften :D
Anleitung zum Einrichten von Vercel 🔨
- Gehe zu vercel.com
- Klicke auf
Log in
- Melde dich mit deinem GitHub-account an, indem du
Continue with GitHub
klickst - Verbinde dich mit GitHub und erlaube den Zugriff auf alle Repositories (falls gefordert)
- Forke dieses Repository
- Gehe zurück zu deinem Vercel dashboard
- Klick
Import Project
- Klick
Import Git Repository
- Wähle root und füge eine Umgebungsvariable namens PAT_1 (siehe Abbildung) die als Wert deinen persönlichen Access Token (PAT) hat hinzu, den du einfach hier erzeugen kannst (lasse alles wie es ist, vergebe einen beliebigen Namen)
- Klicke deploy, und das wars. Besuche deine domains um die API zu benutzen!
💖 Unterstütze das Projekt
Ich versuche alles was ich kann als Open-Source zur Verfügung zu stellen, als auch jedem der Hilfe bei der Benutzung dieses Projektes braucht zu antworten. Natürlich beansprucht sowas Zeit und Du kannst diesen Dienst kostenlos benutzen.
Dennoch, wenn Du dieses Projekt benutzt und damit zufrieden bist oder mich einfach nur motivieren möchtest weiterhin daran zu arbeiten, gibt es verschiedene Sachen die Du machen kannst:-
- Erwähne und verlinke das Projekt in deiner Readme wenn du es benutzt :D
- Geb dem Projekt einen Stern hier auf GitHub und teile es 🚀
- - Du kannst einmalige Spenden via PayPal tätigen. Ich kaufe mir wahrscheinlich einen
KaffeeTee davon. 🍵
Vielen Dank! ❤️
Mitarbeit an dem Projekt ist immer Willkommen! <3
Gebaut mit ❤️ und JavaScript.