Δημιουργός σημάτων (SVG τύπου Shields)
Προεπισκόπηση
Κώδικας SVG
Markdown (shields.io)
Markdown (SVG σε δικό σας hosting)
Κατεβάστε το παραπάνω SVG, κάντε commit στο αποθετήριό σας (για παράδειγμα ως badge.svg) και αναφερθείτε σε αυτό με αυτή τη σχετική διαδρομή, ώστε να μην εξαρτάστε από το shields.io.
HTML
reStructuredText
AsciiDoc
Στατικό URL shields.io
Τεχνικές λεπτομέρειες
Πώς λειτουργεί ο δημιουργός σημάτων
Τι κάνει ο δημιουργός σημάτων
Ο δημιουργός σημάτων δημιουργεί σήματα κατάστασης τύπου shields ως αυτόνομα αρχεία SVG. Εισαγάγετε μια ετικέτα και ένα μήνυμα, επιλέξτε χρώματα (ονόματα shields όπως brightgreen, τιμές hex ή rgb) και ένα από πέντε στιλ: flat, flat-square, plastic, for-the-badge ή social. Τα πλάτη κειμένου προσεγγίζονται από τις μετρικές της Verdana ώστε το σήμα να ταιριάζει στο περιεχόμενό του, και όλα αποδίδονται στο πρόγραμμα περιήγησής σας. Λαμβάνετε τον κώδικα SVG, λήψη, το αντίστοιχο URL shields.io και έτοιμα αποσπάσματα για επικόλληση.
Συνηθισμένες περιπτώσεις χρήσης
Τα σήματα README συνοψίζουν την κατάσταση build, την κάλυψη, την έκδοση, την άδεια χρήσης, τις υποστηριζόμενες πλατφόρμες και τη χορηγία. Χρησιμοποιήστε το εργαλείο όταν θέλετε ένα προσαρμοσμένο σήμα που δεν προσφέρει το shields.io, ένα σήμα που πρέπει να λειτουργεί εκτός σύνδεσης ή σε ιδιωτικό δίκτυο ή ένα στατικό SVG στο αποθετήριό σας, ώστε η τεκμηρίωση να μη χαλάει όταν μια υπηρεσία τρίτου δεν λειτουργεί. Οι προεπιλογές για build passing, άδεια MIT, έκδοση, coverage και PRs welcome σάς δίνουν μια γρήγορη αρχή.
Μορφές εξόδου
Η έξοδος περιλαμβάνει ακατέργαστο SVG, Markdown με URL εικόνας shields.io, Markdown που δείχνει σε badge.svg σε δικό σας hosting, ετικέτα HTML img, οδηγία image του reStructuredText και μακροεντολή image του AsciiDoc. Το στατικό URL shields.io ακολουθεί τους τεκμηριωμένους κανόνες διαφυγής: μια παύλα γίνεται δύο παύλες, μια κάτω παύλα γίνεται δύο κάτω παύλες και τα κενά γίνονται κάτω παύλες. Το URL δημιουργείται μόνο ως κείμενο και δεν ζητείται ποτέ.
Συνηθισμένες παγίδες και οριακές περιπτώσεις
Τα χρώματα που δεν είναι αναγνωρισμένο όνομα, τιμή hex ή τριάδα rgb() αγνοούνται και χρησιμοποιείται το προεπιλεγμένο, κάτι που εμποδίζει την έγχυση markup στο SVG. Τα λογότυπα πρέπει να είναι base64 data URI SVG ή PNG και ενσωματώνονται ως εικόνες, ποτέ ως ακατέργαστο markup. Το πλάτος του σήματος είναι προσέγγιση, επομένως πολύ ασυνήθιστες γραμματοσειρές ή μη λατινικό κείμενο μπορεί να αποδοθούν ελαφρώς πλατύτερα από το πλαίσιο. Το GitHub σερβίρει SVG από το αποθετήριό σας με περιοριστική πολιτική περιεχομένου, γι' αυτό χρησιμοποιήστε το raw URL ή την παραλλαγή shields.io όταν ενσωματώνετε εκτός αποθετηρίου.