GitHub Badges kan øge læsbarheden af et arkiv ved at give brugerne en hurtig måde at registrere lagermetrikerne på. Badges kan integreres i din README.md for at afklare vigtigheden og nødvendigheden af dit projekt for andre udviklere. Som et resultat får læserne en rigtig hurtig idé om arkivet ved at kontrollere de vedhæftede badges.
Der er mange GitHub-badges tilgængelige på internettet, her er de fem mest informative badges, der skal medtages i din README.md-fil. For hvert anført badge gives den tilsvarende Markdown-kode.
Hvad kan GitHub-mærker gøre for dig?
Tilføjelse af GitHub-badges til dit arkiv kan virke trivielt, men faktisk er det utroligt nyttigt. Alt hvad du skal gøre er at importere Markdown-kode fra kilden til din README.md-fil.
Da jeg oprettede mit Python Programming GitHub-lager, udeladte jeg badges. Mit uudsmykkede lager havde det rigtige indhold, men skiller sig ikke ud. På grund af dette fik arkivet meget lidt trafik (unikke besøgende).
Relaterede: Sådan oprettes et GitHub-arkiv
Vil du dele dine udviklingsprojekter online? Sådan kommer du i gang med dit første Github-arkiv.
Efter at have tilføjet flere badges til mit arkiv så jeg en automatisk stigning i de eksterne besøgende (fra 5 til 767) månedligt (se dine unikke besøgende i Indsigt> Trafik på dit arkiv.)
Min indbakke var fyldt med kommentarer om, hvor godt mit arkiv skiller sig ud fra andre Python-programmeringslagre på grund af badges. Et simpelt GitHub-badge kan ændre udseendet på dit arkiv fuldstændigt.
Husk altid dette: et badge er 1000 værd kode værd.
GitHub Stats-badget viser de samlede stjerner, forpligtelser, pullanmodninger, problemer og bidrag fra dit GitHub-arkiv.
- Stjerner: Brugere gemmer GitHub-arkiver (som bogmærker). Dette indikerer, at brugeren er interesseret og ønsker at holde sig ajour med det gemte arkiv. Et stjernemarkeret arkiv kan dog ikke redigeres.
- Forpligter sig: At gemme en ændring i et lager kaldes en forpligtelse. Forskellige detaljer er vedhæftet en forpligtelse, indhold, besked (beskrivelse), forfatternavn og tidsstempel.
- Træk anmodning: En pullanmodning informerer andre om forbedringer, du har skubbet til et andet GitHub-lager, undtagen dit. Vi henviser ofte til Pull Request som hjertet i GitHub Collaboration.
- Problemer: GitHub-problemer bruges til at få brugerfeedback, spore ideer, forbedringer og listefejl rapporteret til lageret.
- Bidrag: GitHub-bidrag angiver antallet af bidrag, der er leveret til andre arkiver. Et bidrag kan leveres ved hjælp af en Pull Request.
For at tilføje GitHub Stats-badgen til dit arkiv skal du integrere nedenstående Markdown-kode i din README.md-fil.
! [Dit arkivs statistik] ( https://github-readme-stats.vercel.app/api? brugernavn = Dit_GitHub_Username & show_icons = sandt)
Sørg for at ændre brugernavn = værdi til dit GitHubs brugernavn. GitHub Stats-mærket giver også ranger såvel som S + (top 1%), S (top 25%), A ++ (top 45%), A + (top 60%) og B + (alle). Jo højere din statistik er, desto bedre er din placering.
Som navnet antyder, viser badgen Most Used Languages de mest almindelige sprog, der bruges i hele GitHub. Det er en GitHub-måling af hvilke sprog som f.eks HTML, CSS, JavaScript, Python, Go, og flere har mest kode på GitHub. Sprogene er anført i faldende rækkefølge.
Relaterede: Hvilket programmeringssprog skal du lære?
For at tilføje badget Mest brugte sprog til dit arkiv skal du integrere Markdown nedenfor i din README.md-fil.
! [Dit arkivs statistik] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Your_GitHub_Username&theme=blue-green)
Den eneste ulempe ved dette badge er, at det ikke viser Markdown som det mest anvendte sprog.
Contributors Badge viser alle operationer såsom tilføjelser, sletningerog forpligter sig der er blevet udført på dine arkiver. Når du fletter en pull-anmodning i dit lager, tilføjes den person, der oprettede anmodningen, som en bidragyder. Det er virkelig en god vane at kreditere de bidragydere, der har investeret deres tid i at levere en opdatering til dit arkiv.
Contributors Badge kan genereres ved hjælp af contributors-img, en webapplikation, der genererer et billede for at vise listen over bidragydere.
At generere bidragyderens image er ret trivielt. Naviger til webstedet contributors-img, og indsæt navnet på dit arkiv sammen med din brugernavn for at generere URL'en. Alternativt skal du blot integrere Markdown-koden nedenfor for at få billedet.
! [GitHub Contributors Image] ( https://contrib.rocks/image? repo = Dit_GitHub_Username / Dit_GitHub_Repository_Name)
Den tilfældige vitsegenerator genererer en teknisk vittighed i form af spørgsmål og svar. For eksempel, "Hvad er et computervirus? Terminal sygdommen”.
For at bruge badgen skal du integrere Markdown-koden i din README.md-fil som vist nedenfor.
## 😂 Her er en tilfældig vittighed, der får dig til at grine!
! [Vittighedskort] ( https://readme-jokes.vercel.app/api)
Profilvisningen Tæller-badge viser antallet af gange, din GitHub-profil er blevet set i din profil. For at generere dette badge skal du integrere følgende Markdown-kode:
! [Profilvisning tæller] ( https://komarev.com/ghpvc/?username=Your_GitHub_Username)
For at generere antallet af visninger af dit arkiv kan du bruge HITS (Sådan sporer idioter succes) badge. Det er en enkel måde at se, hvor mange mennesker der har besøgt din GitHub lager:
! [Hits] ( https://hitcounter.pythonanywhere.com/count/tag.svg? url = Sæt_Din_GitHub_Repository_Link_ Here)
Men ulempen ved både Profile View-tælleren og HITS er, at de ikke viser antallet af visninger med unikke ID'er. Hver gang du genindlæser browseren / lageret, tælles antallet op. Man kunne let få flere visninger ved at opdatere siden.
Fuld implementering af GitHub-badges
Jeg har brugt mit GitHub-lager som et eksempel. For at generere badges anbefales det, at du tilføjer disse koder til din valgte README.md-fil. Hvis du ikke har en README.md-fil i dit GitHub-lager, er det manuelt at oprette en manuelt at oprette en.
# Top 5 badges, der tager dit GitHub-lager til det næste niveau
## 1. GitHub-statistik
! [Dit arkivs statistik] ( https://github-readme-stats.vercel.app/api? brugernavn = Tanu-N-Prabhu & show_icons = sandt)
## 2. Mest brugte sprog
! [Dit arkivs statistik] ( https://github-readme-stats.vercel.app/api/top-langs/?username=Tanu-N-Prabhu&theme=blue-green)
## 3. Contributors Badge
! [Dit arkivs statistik] ( https://contrib.rocks/image? repo = Tanu-N-Prabhu / Python)
## 4. Tilfældig joke-generator
! [Vittighedskort] ( https://readme-jokes.vercel.app/api)
## 5. Profil Vis tæller
! [Profilvisning tæller] ( https://komarev.com/ghpvc/?username=Tanu-N-Prabhu)
### Repository View Counter - HITS
! [Hits] ( https://hitcounter.pythonanywhere.com/count/tag.svg? url = https://github.com/Tanu-N-Prabhu/Python)
Der er ikke behov for at udføre eller køre ovenstående markdown-kodestykke på din README.md-fil. I det øjeblik du gemmer filen med (.md) udvidelse, gengiver GitHub automatisk output, og ændringerne reflekteres direkte i dit arkiv.
Flere GitHub-badges tilgængelige
Nu hvor du ved, hvordan du tilføjer GitHub Badges til dit arkiv, er det en god mulighed for udviklere og enkeltpersoner, der kan bruge disse badges til at øge læsbarheden af deres arkiver. Det er ikke så svært - alt hvad du skal gøre er at integrere få linjer med Markdown-kode for at generere badges.
Jo flere badges du inkluderer i dit arkiv, jo mere opmærksomhed får du. Et enkelt badge vil være i stand til at give nyttige oplysninger med hensyn til statistik, status og metrics.
Vil du få styr på software på GitHub? Sådan gør du det øst med det strømlinede GitHub Desktop-værktøj.
- Programmering
- Markdown
- GitHub
Abonner på vores nyhedsbrev
Deltag i vores nyhedsbrev for tekniske tip, anmeldelser, gratis e-bøger og eksklusive tilbud!
Et trin mere !!!
Bekræft din e-mail-adresse i den e-mail, vi lige har sendt dig.