- calculateRank.js link - themes/index.js file link
14 KiB
GitHub Readme Stats
Zeige dynamisch generierte GitHub-Statistiken in deinen Readmes!
简体中文 · Español · Deutsch · 日本語 · Português Brasileiro · 한국어
Du magst das Projekt? Wie wäre es mit einer kleinen Spende um es weiterhin am Leben zu erhalten?
Funktionalitäten
- GitHub Stats Card
- GitHub Extra Pins
- Top Programmiersprachen Card
- Erscheinungsbild/Themes
- Anpassungen
- Selber betreiben
GitHub Stats Card
Kopiere einfach folgendes in dein Markdown und das wars. Echt simpel!
Passe den Wert des URL-Paramters ?username=
so an, dass dort dein GitHub Username 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 Dingen 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"])
Icons anzeigen
Um Icons 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 auschecken. Außerdem kannst du neue Themes beisteuern wenn du möchtest, contributions sind gern gesehen :D
Anpassungen/Personalisierung
Du kannst das Erscheinungsbild deiner Stats Card
oder Repo Card
, mithilfe von URL-Parametern, nach deinen Vorlieben anpassen.
Anpassungsoptionen:
Option | Type | Beschreibung | Statistiken (default) | Repo (default) | Top Programmiersprachen (default) |
---|---|---|---|---|---|
title_color | hex color | Titelfarbe | 2f80ed | 2f80ed | 2f80ed |
text_color | hex color | Textkörperfarbe | 333 | 333 | 333 |
icon_color | hex color | Iconfarbe | 4c71f2 | 586069 | 586069 |
bg_color | hex color | Hintergrundfarbe | FFFEFE | FFFEFE | FFFEFE |
line_height | number | kontrolliert die Zeilenhöhe zwischen dem Text | 30 | N/A | N/A |
hide_rank | boolean | blendet das Ranking aus | false | N/A | N/A |
hide_title | boolean | blendet den Statistik-Titel aus | false | N/A | false |
hide_border | boolean | blendet den Rahmen aus | false | N/A | N/A |
show_owner | boolean | zeigt den Namen des Besitzers in der Repo-Karte | N/A | false | N/A |
show_icons | boolean | zeige Icons an | false | N/A | N/A |
theme | string | setze eingebaute themes | 'default' | 'default_repocard' | 'default' |
cache_seconds | number | manuelles setzen der Cachezeiten | 1800 | 1800 | 1800 |
hide_langs_below | number | verberge Sprachen unter einem bestimmten Schwellwert | N/A | N/A | undefined |
Hinweis bzgl. des Caches: Wenn die Anzahl der Forks und Stars geringer als 1Tsd ist, haben die Repo-Cards eine default Cachezeit von 30 Minuten (1800 Sekunden), ansonsten beträgt diese 2 Stunden (7200 Sekunden). Außerdem ist der Cache auf eine Minimum von 30 Minuten und ein Maximum von 24 Stunden begrenzt.
GitHub Extra Pins
GitHub extra pins ermöglicht es, mit Hilfe eines GitHub-Readme-Profiles, mehr als 6 Repositories in deinen Profil anzuzeigen.
Und Bääm! Du bist nicht mehr auf 6 pinned 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 Usernamen des Repo Eigentümers anzuzeigen.
Top Programmiersprachen Card
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 der gleichen, 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)
Verberge Programmiersprachen unter einem bestimmten Schwellwert
Benutze den ?hide_langs_below=NUMBER
URL-Parameter um Programmiersprachen unter einem bestimmten prozentualen Schwellwert auszublenden.
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide_langs_below=1)](https://github.com/anuraghazra/github-readme-stats)
Beispiel
Alle Beispiele
- Default
- Ausblenden bestimmter Statistiken
- Icons anzeigen
- Erscheinungsbild/Themes
Choose from any of the default themes
- Stats Card anpassen
- Repo Card anpassen
- Top Programmiersprachen
Kleiner Tip (Ausrichten der Repo Cards)
Ü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="left" 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="left" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
</a>
Betreibe es auf deiner eigenen Vercel-Instanz
Da die GitHub API nur 5tsd 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-Button um loszulegen!
Hinweis: Seit #58 sollte es möglich sein mehr als 5tsd 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, wenn 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 is immer Willkommen! <3
Gebaut mit ❤️ und JavaScript.