วิธีใช้งาน
- พิมพ์ Markdown ในตัวแก้ไข หรือกด “ลองใช้ตัวอย่าง” เพื่อโหลดเอกสารที่มีตารางและรายการงาน
- ดูตัวอย่างอัปเดตขณะพิมพ์ เปลี่ยนเป็น “ซอร์ส HTML” เพื่อดูมาร์กอัปที่สร้างขึ้น
- เปิดหรือปิด GitHub Flavored Markdown หรือการขึ้นบรรทัดใหม่หนึ่งครั้งให้ตรงกับที่จะเผยแพร่ข้อความ
- คัดลอก HTML ไปยัง CMS หรืออีเมล หรือดาวน์โหลดผลลัพธ์เป็นไฟล์ .html หรือ .md
วิธีการทำงาน
Markdown จะถูกแปลงด้วย marked ซึ่งเป็น parser โอเพนซอร์สที่ใช้กันอย่างแพร่หลายและเป็นไปตามข้อกำหนด CommonMark และเมื่อเปิดตัวเลือก GFM จะรองรับ GitHub Flavored Markdown: ตารางแบบ pipe ที่จัดแนวคอลัมน์, รายการงาน, ~~ขีดฆ่า~~ และลิงก์อัตโนมัติจาก URL เปล่า เชิงอรรถ, คณิตศาสตร์ และแผนภาพ Mermaid ไม่ได้เป็นส่วนหนึ่งของข้อกำหนดเหล่านี้ และจะแสดงเป็นข้อความธรรมดา
Markdown อาจมี HTML ดิบอยู่ด้วย และ HTML นั้นจะถูกส่งผ่านไปโดยไม่เปลี่ยนแปลง เช่นเดียวกับที่ตัวแสดงผล Markdown ส่วนใหญ่ทำ เพื่อความปลอดภัยของคุณ ตัวอย่างแสดงผลจะไม่ถูกแทรกเข้าในหน้านี้ แต่จะแสดงผลภายในเฟรมแบบแซนด์บ็อกซ์ที่ไม่อนุญาตให้เรียกใช้สคริปต์ ส่งฟอร์ม เปิดป๊อปอัป หรือเข้าถึงไซต์นี้ และนโยบาย Content Security Policy จะบล็อกสคริปต์ สไตล์ชีตภายนอก ฟอนต์ และเฟรม แท็ก <script> หรือแอตทริบิวต์ onclick ใน Markdown ของคุณจะแสดงในซอร์ส HTML แต่ไม่ถูกเรียกทำงาน ลิงก์ในตัวอย่างแสดงผลจะแสดงแต่ไม่เปิด หากต้องการเปิด ให้คัดลอก URL เอง
ตัวอย่างแสดงผลใช้สไตล์ชีตแบบกลาง ๆ คล้ายกับตัวแสดงผล README ทั่วไป เว็บไซต์หรือ GitHub ของคุณอาจจัดรูปแบบ HTML เดียวกันนี้แตกต่างออกไป HTML ที่คัดลอกเป็นเฉพาะส่วนเนื้อหาโดยไม่มีสไตล์ ไฟล์ .html ที่ดาวน์โหลดจะเพิ่มสไตล์ชีตพื้นฐานเพื่อให้ดูเหมือนตัวอย่างแสดงผล HTML ที่ดาวน์โหลดหรือคัดลอกไม่ผ่านการทำความสะอาด ดังนั้นหากมีสคริปต์อยู่ สคริปต์ก็จะทำงานในที่ที่คุณวางหรือเปิด
ตัวอย่าง
ตรวจสอบ README ก่อน push
วาง README.md เพื่อตรวจสอบว่าคอลัมน์ตารางตรงกัน รายการงานแสดงเป็นช่องทำเครื่องหมาย และบล็อกโค้ดมีรั้วถูกต้อง ก่อนที่ไฟล์จะขึ้น GitHub
เขียนสำหรับ CMS ที่รับ HTML
ร่างโพสต์บล็อกด้วย Markdown จากนั้นกด “คัดลอก HTML” และวางมาร์กอัป <h2>, <p> และ <ul> ลงในตัวแก้ไข HTML ของ CMS
การขึ้นบรรทัดแบบแชต
ข้อความจากแอปแชตมีบรรทัดคั่นด้วยการขึ้นบรรทัดเดียว การเปิด “ถือว่าการขึ้นบรรทัดเดียวเป็น <br>” จะแยกบรรทัดเหล่านั้นออกจากกัน แทนที่จะรวมเป็นย่อหน้าเดียว
คำถามที่พบบ่อย
การวาง Markdown จากแหล่งที่ไม่รู้จักปลอดภัยหรือไม่
ใช่ สำหรับการดูตัวอย่าง HTML ที่แสดงผลจะอยู่ในเฟรมแบบแซนด์บ็อกซ์ที่ปิดใช้สคริปต์ ดังนั้นแม้แต่แท็ก <script> หรือตัวจัดการเหตุการณ์ในข้อความก็จะไม่ทำงานที่นี่ ควรระวังจุดที่คุณวาง HTML ที่ส่งออก เพราะ HTML นั้นไม่ผ่านการทำความสะอาด
ทำไมรูปภาพจึงไม่แสดง
รูปภาพจากเว็บไซต์อื่นถูกบล็อกตามค่าเริ่มต้น เพื่อไม่ให้ตัวอย่างแสดงผลส่งคำขอเครือข่าย เปิด “โหลดรูปภาพจากเว็บไซต์อื่น” เพื่อแสดงรูปเหล่านั้น เส้นทางสัมพัทธ์เช่น ./docs/screenshot.png ใช้ไม่ได้เพราะไฟล์ไม่ได้อยู่ที่นี่
รองรับเชิงอรรถ สูตรคณิตศาสตร์ หรือไดอะแกรมหรือไม่
ไม่รองรับ โดยรองรับ CommonMark และ GitHub Flavored Markdown (ตาราง รายการงาน ข้อความขีดฆ่า ลิงก์อัตโนมัติ) เชิงอรรถ สูตรคณิตศาสตร์ LaTeX และไดอะแกรม Mermaid เป็นส่วนขยายที่ตัวอย่างนี้ปล่อยเป็นข้อความธรรมดา
ทำไมการขึ้นบรรทัดใหม่ครั้งเดียวจึงไม่ขึ้นบรรทัดใหม่
ใน Markdown มาตรฐาน การขึ้นบรรทัดใหม่หนึ่งครั้งภายในย่อหน้าจะถือเป็นช่องว่าง ให้จบบรรทัดด้วยช่องว่างสองตัว เว้นบรรทัดว่าง หรือเปิดใช้ “ถือว่าการขึ้นบรรทัดใหม่หนึ่งครั้งเป็น <br>”
ความเป็นส่วนตัว
Markdown ถูกแปลงในเบราว์เซอร์ของคุณและไม่มีการอัปโหลดหรือจัดเก็บ ตัวอย่างไม่โหลดสิ่งใดจากอินเทอร์เน็ต ยกเว้นเมื่อคุณอนุญาตให้โหลดรูปภาพจากเว็บไซต์อื่น จากนั้นรูปภาพเหล่านั้นจะถูกเรียกโดยตรงจากโฮสต์ของรูปภาพ