ชีตสรุปคำสั่ง Markdown
เลือกหัวข้อ Markdown
เริ่มจากตัวอย่างหนึ่งกลุ่ม แล้วจึงเปิดเอกสารอ้างอิงฉบับเต็ม
ไวยากรณ์ Markdown ที่สำคัญถูกจัดกลุ่มตามหัวข้อ พร้อมแสดงต้นฉบับที่คัดลอกได้ควบคู่กับผลลัพธ์จากตัวแยกวิเคราะห์จริง เนื้อหาครอบคลุมพื้นฐาน CommonMark (หัวข้อ รายการ การเน้น ลิงก์ รูปภาพ และบล็อกโค้ดแบบมีรั้ว) รวมถึงส่วนขยาย GitHub Flavored Markdown (ตาราง รายการงาน ขีดฆ่า และการสร้างลิงก์ให้อัตโนมัติสำหรับ URL ทั่วไป) ใช้เป็นข้อมูลอ้างอิงเมื่อต้องทำงานกับ GitHub, GitLab, Obsidian และเครื่องมือสร้างเว็บไซต์แบบสแตติก
วิธีใช้ชีตสรุปนี้
-
1
เรียกดูตามหมวดหมู่
ข้ามไปยังหัวข้อ รายการ โค้ด ลิงก์ ตาราง หรือส่วนขยาย GFM
-
2
เปรียบเทียบต้นฉบับกับผลลัพธ์
ตัวอย่างแต่ละรายการแสดง Markdown ต้นฉบับควบคู่กับผลลัพธ์จากตัวแยกวิเคราะห์ GFM จริง
-
3
คัดลอกสนิปเป็ต
แตะคัดลอกเพื่อดึงต้นฉบับของตัวอย่างใดก็ได้
-
4
ตรวจสอบป้ายกำกับไวยากรณ์
ตัวอย่างแต่ละรายการมีป้าย CommonMark หรือ GitHub Flavored Markdown (GFM)
หัวข้อ
# หัวข้อ H1
## ส่วน H2
### ส่วนย่อย H3
ควรใช้รูปแบบ ATX (#) แทน Setext (=== ใต้ข้อความ) ตัวแยกวิเคราะห์ทุกตัวรองรับทั้งสองแบบ แต่รูปแบบ ATX อ่านง่ายกว่าเมื่อดูใน diff
การเน้น
*ตัวเอียง* หรือ _ตัวเอียง_, **ตัวหนา** หรือ __ตัวหนา__, ***ตัวหนาเอียง***; GFM เพิ่ม ~~ขีดฆ่า~~ เข้ามา
รายการ
รายการที่ไม่เรียงลำดับใช้ -, * หรือ + (เลือกอย่างใดอย่างหนึ่งแล้วใช้ให้สม่ำเสมอ):
- รายการแรก
- รายการที่สอง
- ซ้อนกัน (เว้นวรรคสองครั้ง)
รายการที่เรียงลำดับจะจัดเลขใหม่โดยอัตโนมัติ:
1. รายการ
1. รายการ
1. รายการ
โค้ด
แบบอินไลน์: `code` บล็อกแบบมีรั้ว โดยใส่แท็กภาษาได้ตามต้องการ:
```python
def hello(name):
return f"สวัสดี, {name}"
```
หากคุณชอบไวยากรณ์แบบเดิม ให้เยื้องบล็อกโค้ดด้วยการเว้นวรรคสี่ครั้ง
ลิงก์และรูปภาพ
[ข้อความลิงก์](https://example.com)
[ลิงก์พร้อมชื่อกำกับ](https://example.com "คำแนะนำ")

รูปแบบอ้างอิงช่วยไม่ให้ URL ยาว ๆ อยู่ในย่อหน้า:
ดู[เอกสาร][1]
[1]: https://example.com/docs
ตาราง (GFM)
| Col A | Col B |
|-------|------:|
| a | 1 |
| b | 22 |
การจัดแนวใช้เครื่องหมายทวิภาคในแถวคั่น: :--- ชิดซ้าย, :---: กึ่งกลาง, ---: ชิดขวา
รายการงาน (GFM)
- [x] เสร็จแล้ว
- [ ] ที่ต้องทำ
ข้อผิดพลาดที่พบบ่อย
- การเว้นวรรคสองครั้งท้ายบรรทัด จะแทรกการขึ้นบรรทัดใหม่ภายในย่อหน้า ส่วนการเว้นวรรคเพียงครั้งเดียวจะเพียงเชื่อมสองบรรทัดเข้าด้วยกัน
- ต้องมีบรรทัดว่างก่อนองค์ประกอบระดับบล็อกส่วนใหญ่ (หัวข้อ รายการ บล็อกโค้ด)
- อย่าใช้แท็บเยื้องเครื่องหมายรายการ หากตัวเรนเดอร์ของคุณต้องการการเว้นวรรค ให้ใช้การเว้นวรรคสองหรือสี่ครั้งแทน
- ใช้ แบ็กสแลชเพื่อหลีก (escape) เมื่อต้องการแสดงเครื่องหมายวรรคตอนตามตัวอักษร:
\*ไม่ใช่ตัวเอียง\* - อัญประกาศอัจฉริยะ ต่างกันไปตามตัวเรนเดอร์ โดย GitHub จะคงไว้ตามเดิม ส่วน Pandoc จะแปลงให้
คำถามที่พบบ่อย
CommonMark กำหนดแกนหลักที่ใช้ข้ามแพลตฟอร์มได้ เช่น หัวข้อ รายการ ลิงก์ และบล็อกโค้ดแบบมีรั้วพร้อมข้อมูลกำกับที่ใส่หรือไม่ก็ได้ ส่วน GFM เพิ่มตาราง รายการงาน ขีดฆ่า และการสร้างลิงก์อัตโนมัติสำหรับ URL ทั่วไป โปรแกรมแก้ไขอื่นอาจรองรับเพียงบางส่วนหรือเพิ่มส่วนขยายของตนเอง
Markdown ถือว่าการขึ้นบรรทัดครั้งเดียวเป็นการเว้นวรรค หากต้องการ <br> ให้จบบรรทัดด้วยการเว้นวรรคสองครั้งท้ายบรรทัด หรือใช้ \ ท้ายบรรทัดในรูปแบบ GFM
ได้ในตัวแยกวิเคราะห์ส่วนใหญ่ แท็ก HTML ระดับบล็อกจะถูกส่งผ่านไปตรง ๆ อย่างไรก็ตาม ตัวเรนเดอร์บางตัวจะทำความสะอาด (sanitize) ข้อมูลนั้น (เช่น GitHub จะลบสคริปต์แบบอินไลน์และแอตทริบิวต์เหตุการณ์ออก)
CommonMark ไม่มีไวยากรณ์สารบัญในตัว GitHub สร้างจุดยึดให้หัวข้อและแสดงโครงร่างสำหรับไฟล์ที่มีหลายหัวข้อ ส่วนแพลตฟอร์มอื่นมีกฎของตนเอง โดย MkDocs ใช้ [TOC] ได้เมื่อเปิดส่วนขยายที่เกี่ยวข้อง และ Docusaurus สร้างสารบัญหน้าจากหัวข้อ
กฎของ CommonMark และ GFM ใช้ได้ แต่ Obsidian ยังเพิ่มลิงก์วิกิ ([[ชื่อหน้า]]), คำเตือนแบบ callout และบล็อกฝังตัวซึ่งเป็นฟีเจอร์เฉพาะของ Obsidian เท่านั้น, สิ่งเหล่านี้ไม่ได้อยู่ในชีตสรุปฉบับนี้
เครื่องมือที่เกี่ยวข้อง
ตารางอ้างอิง ASCII
ตาราง ASCII ครบตั้งแต่ 0 ถึง 127 พร้อมค่าเลขฐานสิบ ฐานสิบหก ฐานแปด ฐานสอง และรูปแบบการอ้างอิงอักขระแบบตัวเลขของ HTML รวม NUL, LF และ DEL
ตัวลดรูปพีชคณิตบูลีน
ลดรูปนิพจน์บูลีนด้วยแผนผัง Karnaugh และอัลกอริทึม Quine-McCluskey แสดงทุกขั้นตอนการลดรูปและผลลัพธ์สุดท้ายในรูป SOP/POS
เครื่องสร้างตัวอักษรสุ่ม
สร้างตัวอักษร A-Z แบบสุ่ม เลือกจำนวน ตัวพิมพ์ใหญ่ ตัวพิมพ์เล็ก หรือแบบผสม แล้วใช้กับเกม โจทย์ หรือกิจกรรมในห้องเรียน
เลขฐานสองเป็นฐานสิบ
แปลงเลขฐานสองเป็นฐานสิบได้ทันที แสดงการกระจายตามตำแหน่งเพื่อให้เห็นว่าแต่ละบิตมีส่วนอย่างไร
เครื่องกำเนิดจานสี
สร้างพาเลตสีแบบเอกรงค์ ใกล้เคียง คู่ตรงข้าม ไตรแอดิก หรือเตตราดิกจากสี HEX หลัก พร้อมส่งออกตัวแปร CSS ที่คัดลอกได้ทันที
เครื่องมือเลือกสี HEX
เลือกหรือป้อนสี HEX แล้วดูค่า RGB, HSL, CMYK โดยประมาณ ค่าความสว่างสัมพัทธ์ และคอนทราสต์กับสีขาวและสีดำ