ไวยากรณ์พื้นฐาน Markdown
Markdown เป็นภาษามาร์กอัปน้ำหนักเบา มีไวยากรณ์การจัดรูปแบบที่เรียบง่าย ช่วยให้ผู้คนมุ่งเน้นที่เนื้อหามากกว่าการจัดรูปแบบ ใช้รูปแบบข้อความธรรมดาที่อ่านง่ายและเขียนง่ายในการเขียนเอกสาร สามารถผสมกับ HTML ได้ และสามารถส่งออกเป็นไฟล์ HTML, PDF และไฟล์รูปแบบ .md เองได้
แนวคิดการออกแบบ
เป้าหมายของ Markdown คือการบรรลุ "อ่านง่าย เขียนง่าย"
ความอ่านง่าย ไม่ว่าจะอย่างไรก็ตาม เป็นสิ่งที่สำคัญที่สุด เอกสารที่เขียนด้วยรูปแบบ Markdown ควรสามารถเผยแพร่เป็นข้อความธรรมดาได้โดยตรง และดูไม่เหมือนถูกสร้างขึ้นด้วยแท็กหรือคำสั่งรูปแบบมากมาย
เป้าหมายการออกแบบหลักของไวยากรณ์ Markdown คือให้อ่านได้ง่ายที่สุดเท่าที่จะเป็นไปได้ ตามเป้าหมายนี้ เอกสารรูปแบบ Markdown สามารถเผยแพร่ในรูปแบบข้อความธรรมดาได้โดยตรง โดยไม่ดูเหมือนว่าเต็มไปด้วยแท็กหรือคำสั่งการจัดรูปแบบ
—— John Gruber
เข้ากันได้กับ HTML
เป้าหมายของไวยากรณ์ Markdown คือ: กลายเป็นภาษาการเขียนที่เหมาะกับเว็บ
Markdown ไม่ต้องการแทนที่ HTML หรือแม้แต่ใกล้เคียงกับมัน ชนิดของไวยากรณ์มีน้อยมาก ตรงกับ HTML tags เพียงเล็กน้อยเท่านั้น
แท็กที่ไม่อยู่ในขอบเขตที่ Markdown ครอบคลุมสามารถเขียนโดยตรงในเอกสารด้วย HTML ได้ ไม่จำเป็นต้องระบุเพิ่มเติมว่านี่คือ HTML หรือ Markdown เพียงแค่เพิ่มแท็กโดยตรง
ตัวอย่างเช่น เพิ่มตาราง HTML ในไฟล์ Markdown:
นี่คือย่อหน้าธรรมดา
<table>
<tr>
<td>Foo</td>
</tr>
</table>
นี่คือย่อหน้าอื่นการแปลงอักขระพิเศษอัตโนมัติ
ในไฟล์ HTML มีสองอักขระที่ต้องประมวลผลพิเศษ: < และ &
- สัญลักษณ์
<ใช้สำหรับแท็กเริ่มต้น - สัญลักษณ์
&ใช้สำหรับทำเครื่องหมาย HTML entities
Markdown ช่วยให้คุณสามารถเขียนอักขระได้ตามธรรมชาติ การแปลงจะถูกจัดการโดยมันเอง หากอักขระ & ที่คุณใช้เป็นส่วนหนึ่งของ HTML character entity มันจะคงอยู่ตามเดิม มิฉะนั้นจะถูกแปลงเป็น &
องค์ประกอบไวยากรณ์พื้นฐาน
ไวยากรณ์พื้นฐาน Markdown รวมถึงองค์ประกอบต่อไปนี้:
องค์ประกอบระดับบล็อก
- หัวข้อ - ใช้
#เพื่อสร้างหัวข้อระดับต่างๆ - ย่อหน้าและการขึ้นบรรทัดใหม่ - ย่อหน้าและกฎการขึ้นบรรทัดใหม่
- อ้างอิง - ใช้
>เพื่อสร้างบล็อกอ้างอิง - รายการ - รายการแบบมีลำดับและไม่มีลำดับ
- บล็อกโค้ด - รูปแบบพิเศษสำหรับแสดงโค้ด
- เส้นคั่น - สร้างเส้นคั่นแนวนอน
องค์ประกอบอินไลน์
- การเน้น - ข้อความหนาและเอียง
- ลิงก์ - สร้าง hyperlinks
- รูปภาพ - แทรกรูปภาพ
- โค้ดอินไลน์ - เครื่องหมายโค้ดอินไลน์
อื่นๆ
- อักขระหนี - หนีอักขระพิเศษ
- ลิงก์อัตโนมัติ - ระบุลิงก์อัตโนมัติ
ตัวอย่างไวยากรณ์
นี่คือตัวอย่างที่มีไวยากรณ์พื้นฐานหลายประเภท:
# เอกสารของฉัน
นี่คือตัวอย่าง**ข้อความหนา**และ*ข้อความเอียง*
## ตัวอย่างรายการ
### รายการซื้อของ
- แอปเปิล
- กล้วย
- ส้ม
### รายการงาน
1. เรียนรู้ไวยากรณ์พื้นฐาน Markdown
2. ฝึกเขียน
3. แชร์ให้เพื่อน
> นี่คือตัวอย่างบล็อกอ้างอิง Markdown ทำให้การเขียนง่ายและสวยงาม
นี่คือตัวอย่าง[ลิงก์ไปยังหน้าหลัก](/th/)
ตัวอย่างโค้ด:คุณยังสามารถใช้โค้ดอินไลน์ เช่น console.log('Hello World')
แนวทางปฏิบัติที่ดีที่สุด
การใช้หัวข้อ
- แต่ละเอกสารแนะนำให้ใช้หัวข้อระดับ 1 (
#) เพียงหนึ่งตัว - รักษาเหตุผลของระดับหัวข้อ อย่าข้ามระดับ
- เว้นบรรทัดว่างก่อนและหลังหัวข้อ
รูปแบบรายการ
- รายการแบบไม่มีลำดับคงความสอดคล้องของสัญลักษณ์ (ใช้
-,*หรือ+อย่างสม่ำเสมอ) - ไม่จำเป็นต้องมีบรรทัดว่างระหว่างรายการเว้นแต่จะมีหลายย่อหน้า
ลิงก์และรูปภาพ
- ให้ข้อความอธิบายที่มีความหมายสำหรับลิงก์
- ให้ข้อความแทน (alt text) สำหรับรูปภาพ
การแสดงโค้ด
- ใช้รูปแบบโค้ดอินไลน์สำหรับโค้ดสั้น
- ใช้บล็อกโค้ดสำหรับโค้ดยาวหรือหลายบรรทัด
- ระบุภาษาสำหรับบล็อกโค้ดเพื่อให้ได้การเน้นไวยากรณ์
การรองรับเครื่องมือ
แอปพลิเคชัน Markdown เกือบทั้งหมดรองรับองค์ประกอบไวยากรณ์พื้นฐานเหล่านี้ อาจมีความแตกต่างเล็กน้อยระหว่างโปรเซสเซอร์ Markdown ต่างๆ แต่ไวยากรณ์พื้นฐานเป็นสากล
ขั้นตอนต่อไป
ตอนนี้คุณเข้าใจภาพรวมของไวยากรณ์พื้นฐาน Markdown แล้ว คุณสามารถ:
- เรียนรู้การใช้งานโดยละเอียดของแต่ละองค์ประกอบไวยากรณ์
- ดูตารางอ้างอิงไวยากรณ์ เพื่ออ้างอิงอย่างรวดเร็ว
- เรียนรู้ไวยากรณ์ขยาย เพื่อรับฟีเจอร์เพิ่มเติม
- สำรวจการใช้งานขั้นสูง และแนวทางปฏิบัติที่ดีที่สุด
เริ่มเรียนรู้องค์ประกอบไวยากรณ์เฉพาะ: