Markdown Toolbox Logo Markdown Toolbox
บ้าน
บล็อก

แผ่นงานช่วยจำ - สไตล์ Markdown ของ GitHub

2023-12-12

GitHub Flavored Markdown (GFM) ขยายไวยากรณ์ Markdown มาตรฐานเพื่อรวมคุณลักษณะเพิ่มเติมเฉพาะสำหรับ GitHub แผ่นข้อมูลนี้ครอบคลุมด้านสำคัญของ GFM ทำให้การสร้าง README, ปัญหา และเอกสารอื่นๆ บน GitHub ง่ายขึ้น

ไวยากรณ์ที่ขยายออกไป

รายการงาน

  • สร้างรายการงานด้วย - [ ] สำหรับงานที่ยังไม่เสร็จและ - [x] สำหรับงานที่เสร็จแล้ว

    -   [x] งานที่เสร็จแล้ว
    -   [ ] งานที่ยังไม่เสร็จ
    

ข้อความขีดข่วน

  • ใช้เครื่องหมาย ~~ เพื่อขีดข่วนข้อความ

    ~~ข้อความขีดข่วน~~
    

ตาราง

  • สร้างตารางโดยใช้เครื่องหมายขีด - และท่อ |

    | หัวข้อ 1 | หัวข้อ 2 |
    | -------- | -------- |
    | แถว 1    | ข้อมูล 1   |
    | แถว 2    | ข้อมูล 2   |
    

บล็อกรหัสถูกล้อม

  • ใช้เครื่องหมายแบ็คทริกเกอร์สามตัว (```) และระบุภาษาเพื่อเน้นไวยากรณ์

    ```javascript console.log("สวัสดี, โลก!"); ```

การกล่าวถึงผู้ใช้และทีม

  • ใช้ @username เพื่อกล่าวถึงผู้ใช้หรือทีม

การอ้างอิงปัญหาและการดึงคำขอ

  • อ้างอิงปัญหาและการดึงคำขอโดยใช้ #

ไวยากรณ์ Markdown มาตรฐาน

หัวข้อ

  • ใช้ # สำหรับหัวข้อ หัวข้อที่มากขึ้น # หมายถึงหัวข้อที่เล็กลง

การจัดรูปแบบข้อความ

  • ตัวหนา: **ตัวหนา**
  • ตัวเอน: *ตัวเอน*
  • ตัวหนาและตัวเอน: ***ตัวหนา & ตัวเอน***

รายการ

  • รายการที่ไม่มีระเบียบ: เริ่มด้วย -, +, หรือ *.
  • รายการที่เป็นระเบียบ: เริ่มด้วยหมายเลขตามด้วย ..

ลิงค์และรูปภาพ

  • ลิงค์: [ชื่อเรื่อง](URL)
  • รูปภาพ: ![ข้อความแทน](URL)

ความคิดเห็นบล็อค

  • ใช้ > สำหรับความคิดเห็นบล็อค

Markdown ของ GitHub อนุญาตให้เอกสารมีความโต้ตอบและพลิกผันมากขึ้น โดยเฉพาะอย่างยิ่งมีประโยชน์ในบริบทของโครงการร่วมกัน