mirror of
https://github.com/anuraghazra/github-readme-stats.git
synced 2024-12-15 06:04:17 +08:00
269 lines
14 KiB
Markdown
269 lines
14 KiB
Markdown
<p align="center">
|
|
<img width="100px" src="https://res.cloudinary.com/anuraghazra/image/upload/v1594908242/logo_ccswme.svg" align="center" alt="GitHub Readme Stats" />
|
|
<h2 align="center">GitHub Readme Stats</h2>
|
|
<p align="center">Zeige dynamisch generierte GitHub-Statistiken in deinen Readmes!</p>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/actions">
|
|
<img alt="Tests Passing" src="https://github.com/anuraghazra/github-readme-stats/workflows/Test/badge.svg" />
|
|
</a>
|
|
<a href="https://codecov.io/gh/anuraghazra/github-readme-stats">
|
|
<img src="https://codecov.io/gh/anuraghazra/github-readme-stats/branch/master/graph/badge.svg" />
|
|
</a>
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/issues">
|
|
<img alt="Issues" src="https://img.shields.io/github/issues/anuraghazra/github-readme-stats?color=0088ff" />
|
|
</a>
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/pulls">
|
|
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/anuraghazra/github-readme-stats?color=0088ff" />
|
|
</a>
|
|
<br />
|
|
<br />
|
|
<a href="https://a.paddle.com/v2/click/16413/119403?link=1227">
|
|
<img src="https://img.shields.io/badge/Supported%20by-VSCode%20Power%20User%20%E2%86%92-gray.svg?colorA=655BE1&colorB=4F44D6&style=for-the-badge"/>
|
|
</a>
|
|
<a href="https://a.paddle.com/v2/click/16413/119403?link=2345">
|
|
<img src="https://img.shields.io/badge/Supported%20by-Node%20Cli.com%20%E2%86%92-gray.svg?colorA=61c265&colorB=4CAF50&style=for-the-badge"/>
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#alle-beispiele">Beispiel ansehen</a>
|
|
·
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/issues">Fehler melden</a>
|
|
·
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/issues">Funktionalität anfragen</a>
|
|
</p>
|
|
</p>
|
|
<p align="center">Du magst das Projekt? Wie wäre es mit einer kleinen <a href="https://www.paypal.me/anuraghazra">Spende</a> um es weiterhin am Leben zu erhalten?
|
|
|
|
# Funktionalitäten
|
|
|
|
- [GitHub Stats Card](#github-stats-card)
|
|
- [GitHub Extra Pins](#github-extra-pins)
|
|
- [Top Programmiersprachen Card](#top-programmiersprachen-card)
|
|
- [Erscheinungsbild/Themes](#erscheinungsbildthemes)
|
|
- [Anpassungen](#anpassungenpersonalisierung)
|
|
- [Selber betreiben](#betreibe-es-auf-deiner-eigenen-vercel-instanz)
|
|
|
|
# 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.
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
_Hinweis: Die Berechnung des Ranges basiert auf den jeweiligen Benutzerstatistiken, siehe [src/calculateRank.js](./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"]`
|
|
|
|
```md
|
|
![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:
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
### 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 :-
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
#### Alle eingebauten Themes :-
|
|
|
|
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
|
|
|
|
<img src="https://res.cloudinary.com/anuraghazra/image/upload/v1595174536/grs-themes_l4ynja.png" alt="GitHub Readme Stat Themes" width="600px"/>
|
|
|
|
Du kannst dir eine Vorschau [aller verfügbaren Themes](./themes/README.md) ansehen oder die [theme config Datei](./themes/index.js) 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`
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
### Beispiele
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
Benutze die [show_owner](#anpassungenpersonalisierung) Variable, um den Usernamen des Repo Eigentümers anzuzeigen.
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
# 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`
|
|
|
|
```md
|
|
[](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.
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
### Beispiel
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
---
|
|
|
|
### Alle Beispiele
|
|
|
|
- Default
|
|
|
|
|
|
|
|
- Ausblenden bestimmter Statistiken
|
|
|
|
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","issues"])
|
|
|
|
- Icons anzeigen
|
|
|
|
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["issues"]&show_icons=true)
|
|
|
|
- Erscheinungsbild/Themes
|
|
|
|
Choose from any of the [default themes](#themes)
|
|
|
|
|
|
|
|
- Stats Card anpassen
|
|
|
|
|
|
|
|
- Repo Card anpassen
|
|
|
|
|
|
|
|
- Top Programmiersprachen
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
---
|
|
|
|
### 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:
|
|
|
|
```md
|
|
<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](https://github.com/anuraghazra/github-readme-stats/pull/58) sollte es möglich sein mehr als 5tsd Aufrufe pro Stunde ohne Downtimes zu verkraften :D
|
|
|
|
[](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
<details>
|
|
<summary>Anleitung zum Einrichten von Vercel</summary>
|
|
|
|
1. Gehe zu [vercel.com](https://vercel.com/)
|
|
1. Klicke auf `Log in`
|
|
|
|
1. Melde dich mit deinem GitHub-account an, indem du `Continue with GitHub` klickst
|
|
|
|
1. Verbinde dich mit GitHub und erlaube den Zugriff auf alle Repositories, wenn gefordert
|
|
1. Forke dieses Repository
|
|
1. Gehe zurück zu deinem [Vercel dashboard](https://vercel.com/dashboard)
|
|
1. Klick `Import Project`
|
|
|
|
1. Klick `Import Git Repository`
|
|
|
|
1. 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](https://github.com/settings/tokens/new) erzeugen kannst (lasse alles wie es ist, vergebe einen beliebigen Namen)
|
|
|
|
1. Klicke deploy, und das wars. Besuche deine domains um die API zu benutzen!
|
|
</details>
|
|
|
|
## :sparkling_heart: 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 :rocket:
|
|
- [](https://www.paypal.me/anuraghazra) - Du kannst einmalige Spenden via PayPal tätigen. Ich kaufe mir wahrscheinlich einen ~~Kaffee~~ Tee davon. :tea:
|
|
|
|
Vielen Dank! :heart:
|
|
|
|
---
|
|
|
|
Mitarbeit an dem Projekt is immer Willkommen! <3
|
|
|
|
Gebaut mit :heart: und JavaScript.
|