Softonic

เครื่องสร้างแบดจ์ README

ขั้นตอน 1 / 2 Markdown
ผลลัพธ์

พิมพ์ป้ายกำกับ ข้อความ และสี แล้วเครื่องมือนี้จะสร้างแบดจ์แบบคงที่ของ shields.io ซึ่งก็คือป้ายแคปซูลแบนเล็ก ๆ ที่คุณเห็นใต้หัวข้อของ README (build | passing, license | MIT, version | 1.4.0) โดยจะแสดงตัวอย่างแบบเรียลไทม์ และให้ทั้งโค้ด Markdown และ HTML สำหรับวาง Shields.io เป็นบริการแบดจ์มาตรฐานโดยพฤตินัยสำหรับโปรเจกต์โอเพนซอร์ส รูปแบบ URL นั้นเรียบง่ายแต่จำยาก ดังนั้นอินเทอร์เฟซกราฟิกเล็ก ๆ จึงช่วยประหยัดเวลาได้ไม่กี่นาทีเมื่อคุณตั้งค่ารีโปใหม่

วิธีสร้างแบดจ์

  1. 1

    พิมพ์ป้ายกำกับและข้อความ

    ป้ายกำกับคือครึ่งซ้าย (สีเทา) ส่วนข้อความคือครึ่งขวา พิมพ์สิ่งที่คุณต้องการให้แบดจ์แสดง: `build` / `passing`, `coverage` / `98%`, `license` / `MIT`

  2. 2

    เลือกสี

    สีที่มีชื่อ (brightgreen, blue, red, orange) หรือรหัสเลขฐานสิบหก เช่น `#ff0000` โดยจะเติมลงในครึ่งขวาของแบดจ์

  3. 3

    จัดรูปแบบ

    เลือกรูปแบบ (`flat`, `flat-square`, `for-the-badge`, `plastic`, `social`) และหากต้องการ ให้เพิ่มโลโก้ผ่านสลัก simple-icons (github, npm, docker)

  4. 4

    คัดลอก Markdown หรือ HTML

    วางลงในไฟล์ README ของคุณ เพิ่ม URL ลิงก์ที่เป็นตัวเลือกเพื่อทำให้แบดจ์คลิกได้ Shields.io จะเรนเดอร์ SVG เมื่อมีการเรียก

สูตรแบดจ์ที่ใช้บ่อย

เครื่องมือนี้สร้างรูปแบบคงที่ badge/label-message-color หากต้องการแบดจ์ที่แสดงข้อมูลแบบเรียลไทม์ (สถานะการบิลด์ เวอร์ชัน ยอดดาวน์โหลด) ให้คัดลอกรูปแบบ URL ของ shields.io ด้านล่างแล้ววางลงใน README ของคุณได้เลย

วัตถุประสงค์ รูปแบบ URL ของ shields.io
เวอร์ชัน npm https://img.shields.io/npm/v/{package}
ยอดดาวน์โหลด npm https://img.shields.io/npm/dm/{package}
ดาวบน GitHub https://img.shields.io/github/stars/{owner}/{repo}
คอมมิตล่าสุดบน GitHub https://img.shields.io/github/last-commit/{owner}/{repo}
สถานะเวิร์กโฟลว์บน GitHub https://img.shields.io/github/actions/workflow/status/{owner}/{repo}/{workflow.yml}
ใบอนุญาต https://img.shields.io/github/license/{owner}/{repo}
เวอร์ชัน PyPI https://img.shields.io/pypi/v/{package}
ยอดพูล Docker https://img.shields.io/docker/pulls/{org}/{image}
ความครอบคลุม Codecov https://img.shields.io/codecov/c/github/{owner}/{repo}
ป้ายกำกับแบบคงที่ https://img.shields.io/badge/{label}-{message}-{color}

เปรียบเทียบรูปแบบของแบดจ์

  • flat, สี่เหลี่ยมผืนผ้ามุมมนแบบคลาสสิก เป็นค่าเริ่มต้น
  • flat-square, มุมคม ดูทันสมัยขึ้นเล็กน้อย
  • for-the-badge, ตัวพิมพ์ใหญ่ทั้งหมดแบบบล็อก เพื่อดึงความสนใจสูงสุด
  • plastic, ไล่เฉดสีและเงาด้านใน สไตล์เก่า
  • social, มุมมนและโทนสีเรียบ เข้ากับปุ่มดาว/ฟอร์กของ GitHub เอง

เมื่อใดควรใช้แบดจ์

  • บิลด์ + ความครอบคลุม, บอกผู้เข้าชมว่าโปรเจกต์ได้รับการดูแลอยู่จริง
  • เวอร์ชัน + ยอดดาวน์โหลด, บอกว่ามีการใช้งานอยู่
  • ใบอนุญาต, สัญญาณทางกฎหมายสำหรับผู้ที่คิดจะร่วมสนับสนุนหรือใช้งาน
  • ลิงก์เอกสาร, เว็บไซต์เอกสารภายนอกหรือ rustdoc.rs
  • แชท / การสนับสนุน, ลิงก์ไปยัง Discord, Matrix หรือ GitHub Discussions

เมื่อใดไม่ควรใช้แบดจ์

  • สถิติเพื่อความโก้หรูที่ไม่เคยอัปเดต แบดจ์ “ดาว” สำหรับรีโปที่มีศูนย์ดาวทำให้โปรเจกต์ดูเหมือนตายแล้ว
  • ทุกตัวชี้วัดที่เป็นไปได้ แบดจ์ห้าอันเล่าเรื่องราวได้ แต่สิบห้าอันไม่ได้บอกอะไรเลย
  • ข้อมูลซ้ำซ้อน ใบอนุญาตกับ “MIT” สองครั้ง หรือแสดงเวอร์ชันทั้งในแบดจ์และในบรรทัดแรกของข้อความ
  • แบดจ์สำหรับบริการที่คุณไม่ได้ใช้ อย่าเพิ่ม Codecov หากคุณยังไม่ได้ตั้งค่าการรายงานความครอบคลุม เพราะแบดจ์ที่เสียแย่กว่าการไม่มีแบดจ์เลย

การแคชและความน่าเชื่อถือ

Shields.io แคชคำขออย่างจริงจัง แบดจ์ที่อัปเดตช้ามักต้องการเพียงการล้างแคช (เพิ่ม ?v=2) หรือรอไม่กี่นาที หาก shields.io ล่ม GitHub จะแสดงคำว่า “shields” โดยไม่มีกราฟิก ซึ่งควรทราบไว้ แต่ระบบจะกลับมาทำงานได้อย่างรวดเร็ว

คำถามที่พบบ่อย

ไม่ Shields.io ให้บริการฟรีและได้รับทุนจากการบริจาค ผู้ใช้ที่มีปริมาณการใช้งานสูงมากจะได้รับการขอให้โฮสต์เองหรือสนับสนุนโครงการ

ได้ Shields เป็นโอเพนซอร์ส คุณสามารถรันบนโดเมนของคุณเองได้ แต่โปรเจกต์ส่วนใหญ่ไม่จำเป็นต้องทำเช่นนั้น เพราะบริการฟรีนั้นเชื่อถือได้

การแคช เพิ่ม ?cacheSeconds=60 หรือ ?v=anything เพื่อบังคับให้อัปเดต อาจใช้เวลาไม่กี่นาทีในการเผยแพร่

ได้ เพิ่ม ?logo=github (หรือสลัก simple-icons ใดก็ได้) และใช้ ?logoColor=white เพื่อปรับสีไอคอน

ไม่ ทุกอย่างทำงานในเบราว์เซอร์ และ URL ถูกสร้างขึ้นที่ฝั่งไคลเอ็นต์เพื่อให้คัดลอกได้

เครื่องมือที่เกี่ยวข้อง

ตารางอ้างอิง ASCII

ตาราง ASCII ครบตั้งแต่ 0 ถึง 127 พร้อมค่าเลขฐานสิบ ฐานสิบหก ฐานแปด ฐานสอง และรูปแบบการอ้างอิงอักขระแบบตัวเลขของ HTML รวม NUL, LF และ DEL

อ้างอิงตัวอักษร HTML

รายการที่สามารถค้นหาได้ขององค์ประกอบ HTML พร้อมรหัสชื่อและรหัสตัวเลข รวมถึงฟังก์ชันสำเนาด้วยคลิกเดียวสำหรับตัวอักษรพิเศษและสัญลักษณ์ต่างๆ

ตารางอ้างอิงแป้นพิมพ์ลัด

ค้นหาแป้นพิมพ์ลัดเริ่มต้นตามเอกสารของ VS Code, Chrome และ Bash ที่ใช้ GNU Readline บน macOS, Windows และ Linux

ตัวตรวจสอบอีเมล

ตรวจสอบที่อยู่อีเมล: ตรวจไวยากรณ์ RFC 5322 ค้นหา MX เรกคอร์ดแบบเรียลไทม์ พร้อมรายละเอียดส่วนท้องถิ่น โดเมน และความยาว ไม่มีการส่งอีเมลใด ๆ

เครื่องมือสร้าง EditorConfig

สร้างไฟล์ .editorconfig จากกฎการเยื้อง การจบบรรทัด และชุดอักขระของคุณ แล้วเพิ่มเซกชันที่ถูกต้องให้ทุกภาษาในรีโพซิทอรี ทั้ง Python, Go, YAML, Makefile และอื่น ๆ

แปลงจาก CSV เป็น JSON

แปลงไฟล์ CSV ที่มีแถวหัวข้อให้เป็น JSON ในรูปแบบอาร์เรย์ของออบเจกต์ โดยแถวหัวข้อจะทำหน้าที่เป็นคีย์ และแถวข้อมูลจะกลายเป็นออบเจกต์ เพื่อใช้งานกับ API และโค้ด JavaScript

เครื่องมือนี้มีให้บริการในภาษาอื่น