shields
1.0.0
In diesem Fall ist Shields.io, einen Service für präzise, konsistente und lesbare Abzeichen im SVG- und Raster -Format, das problemlos in Github Readmes oder auf einer anderen Webseite aufgenommen werden kann. Der Service unterstützt Dutzende von kontinuierlichen Integrationsdiensten, Paketregistern, Ausschüttungen, App Stores, sozialen Netzwerken, Code -Deckungsdiensten und Code -Analysediensten. Jeden Monat dient es über 1,6 Milliarden Bilder und wird von einigen der beliebtesten Open-Source-Projekte der Welt, gegenüber Code, Vue.js und Bootstrap, verwendet, um nur einige zu nennen.
Dieses Repo hostet:
Machen Sie Ihre eigenen Abzeichen! (Schnellbeispiel: https://img.shields.io/badge/left-right-f39f37 )
Durchsuchen Sie eine vollständige Liste der Abzeichen und lokalisieren Sie ein bestimmtes Abzeichen, indem Sie die Suchleiste verwenden oder die Kategorien durchsuchen. Klicken Sie auf das Abzeichen, um die erforderlichen Datenelemente für diesen Abzeichentyp (wie Ihren Benutzernamen oder Ihr Repo) auszufüllen und optional anpassen (Etikett, Farben usw.). Und es ist bereit für den Gebrauch!
Verwenden Sie die Schaltfläche unten, um Ihre Abzeichen -URL oder Ihr Snippet zu kopieren, der dann zu Orten wie Ihren Github ReadMe -Dateien oder anderen Webseiten hinzugefügt werden kann.
Shields ist ein Community -Projekt. Wir laden Ihre Teilnahme durch Probleme ein und ziehen Anfragen! Sie können die beitragenden Richtlinien lesen.
Fügen Sie beim Hinzufügen oder Ändern eines Dienstes Tests hinzu.
Dieses Projekt hat einen ziemlichen Rückstand an Vorschlägen! Wenn Sie neu im Projekt sind, möchten Sie vielleicht eine Pull -Anfrage eröffnen, um einen von ihnen anzusprechen.
Sie können ein Tutorial zum Hinzufügen eines Abzeichens lesen.
Wenn Sie beabsichtigen, eine Korrektur im Zusammenhang mit Sicherheitslücken zu melden oder zu beitragen, wenden Sie sich bitte zunächst auf unsere Sicherheitsrichtlinien.
npm ci aus, um die Abhängigkeiten zu installieren.npm start um den Badge -Server und den Frontend Dev Server zu starten.http://localhost:3000/ um das Frontend anzusehen. Wenn sich Serverquelldateien ändern, sollte sich der Badge -Server automatisch neu starten (mit Nodemon). Wenn sich die Frontend -Dateien ändern, sollte sich der Frontend Dev Server ( docusaurus start ) automatisch neu laden. Die Abzeichendefinitionen werden jedoch nur vor dem ersten Start des Servers erstellt. Um diese zu regenerieren, führen Sie npm run prestart oder starten Sie manuell neu.
Um ein Abzeichen aus der Befehlszeile zu debuggen, führen Sie npm run badge -- /npm/v/nock aus. Es funktioniert auch mit vollständigen URLs wie npm run badge -- https://img.shields.io/npm/v/nock .
Verwenden Sie npm run debug:server , um den Server im Debug -Modus zu starten. Dieses Rezept zeigt, wie Sie die Anwendung node.js in vs Code debuggen.
Shields hat experimentelle Unterstützung für Gitpod, eine vorkonfigurierte Entwicklungsumgebung, die in Ihrem Browser betrieben wird. Klicken Sie zur Verwendung von GitPod auf die Schaltfläche unten und melden Sie sich mit GitHub an. Gitpod bietet auch ein Browser-Add-On an, obwohl es nicht erforderlich ist. Bitte melden Sie alle Gitpod -Fehler, Fragen oder Vorschläge in Ausgabe Nr. 2772.
Snapshot -Tests stellen sicher, dass wir nicht versehentlich Änderungen vornehmen, die die SVG- oder JSON -Ausgabe beeinflussen. Führen Sie bei absichtlich geänderter Ausgabe SNAPSHOT_DRY=1 npm run test:package zur Vorschau von Änderungen an den gespeicherten Snapshots und SNAPSHOT_UPDATE=1 npm run test:package um sie zu aktualisieren.
Der Server kann so konfiguriert werden, dass Sentry (Konfiguration) und Prometheus (Konfiguration) verwendet werden.
Unsere vollständige Testsuite sowie Codeabdeckung werden täglich ausgeführt.
Es gibt Dokumentationen über das Hosten Ihres eigenen Servers.
Statusabzeichen werden in Open-Source- und privaten Softwareprojekten häufig verwendet. Akademiker haben die "Signal" -Amas für Softwareprojektqualität untersucht. Es gibt viele bestehende Bibliotheken für die Wiedergabe dieser Abzeichen und Alternativen zum Hosted Shields Badge Service. Awesome-Badges ist eine kuratierte Sammlung solcher Ressourcen. Dort können Beiträge berücksichtigt werden. (Das Vorhandensein eines Projekts in dieser Sammlung sollte weder als Bestätigung noch Werbung aus dem Shields -Projekt interpretiert werden)
B.Adge.me war die ursprüngliche Website für diesen Service. Heroku hatte damals etwas, das es schwierig machte, eine Toplevel -Domäne damit zu verwenden, daher die seltsame Domäne. Es verwendete Code, das 2013 aus einer Bibliothek namens GH-Badges entwickelt wurde und beide von Thaddée Tyl entwickelt wurden. Das Projekt fusionierte mit Shields.io, indem es den b.Adge.me -Code verwendet und b.Adge.me.
Die ursprüngliche Abzeichenspezifikation wurde 2013 von Olivier Lacan entwickelt. Es wurde vom Travis CI und ähnlichen Abzeichen inspiriert (damals gab es viel weniger). Im Jahr 2014 hat Thaddée Tyl es mit Hilfe eines Travis CI -Mitarbeiters neu gestaltet und alle davon überzeugt, darauf zu wechseln. Das alte Design heißt heute als plastischer Stil. Der neue ist der flache Stil.
Sie können mehr über die Gründung des Projekts, die Motivation der SVG -Abzeichenspezifikation und die Spezifikation selbst lesen.
Betreuer:
Alumni:
Alle Vermögenswerte und Code unterliegen der CC0 -Lizenz und öffentlich zugänglich, sofern nicht anders angegeben.
Vielen Dank an die Personen und Unternehmen, die Geld, Dienstleistungen oder Zeit spenden, um das Projekt am Laufen zu halten. https://shields.io/community
