- Markdown ช่วยให้คุณจัดรูปแบบข้อความธรรมดาบน GitHub และ Reddit ได้อย่างรวดเร็ว ด้วยไวยากรณ์ที่เบาและจำง่าย
- GitHub Flavored Markdown เพิ่มตาราง รายการสิ่งที่ต้องทำ การแจ้งเตือน หมายเหตุเชิงอรรถ และการนำทางขั้นสูงระหว่างส่วนต่างๆ
- Reddit ใช้ Snoomark ซึ่งเป็นรูปแบบหนึ่งของ Markdown คล้ายกับที่ GitHub ใช้ แต่มีคุณสมบัติเพิ่มเติม เช่น สปอยเลอร์ และวิธีการจัดการรูปภาพที่แตกต่างออกไป
- การควบคุมหัวข้อ รายการ คำพูด โค้ด ลิงก์ และรูปภาพ ช่วยเพิ่มความอ่านง่ายและประสิทธิภาพของเนื้อหาบนทั้งสองแพลตฟอร์มได้อย่างมาก
หากคุณเขียนข้อความบน GitHub บ่อยๆ หรือใช้เวลาบน Reddit มาก การเรียนรู้Markdownจะช่วยประหยัดเวลาและทำให้ชีวิตคุณง่ายขึ้นมาก มันเป็นภาษามาร์กอัปที่มีน้ำหนักเบามาก ช่วยให้คุณจัดรูปแบบข้อความธรรมดาได้อย่างรวดเร็วโดยไม่ต้องยุ่งยากกับการใช้เมนูหรือปุ่ม เพียงแค่ใช้สัญลักษณ์ไม่กี่ตัววางไว้ในตำแหน่งที่ถูกต้อง
บน GitHub คุณจะพบ Markdown ได้ทุกที่ ไม่ว่าจะเป็นใน ไฟล์ README.md ของ repository , issues, pull request, discussions และแม้แต่ในโปรไฟล์ของคุณเอง ส่วน Reddit นั้นใช้ Markdown เวอร์ชันที่เรียกว่า Snoomark (Reddit-style Markdown) ซึ่งสืบทอดไวยากรณ์ส่วนใหญ่มาจาก GitHub แต่ก็มีคุณสมบัติและข้อจำกัดเฉพาะตัวอยู่บ้าง มาดูกันทีละขั้นตอน พร้อมตัวอย่างมากมาย ว่าเราจะใช้ Markdown บน GitHub และ Reddit ได้อย่างรวดเร็วและไม่พลาดข้อมูลสำคัญได้อย่างไร
Markdown คืออะไร และทำไมจึงมีประโยชน์มากบน GitHub และ Reddit?
Markdown เป็นภาษามาร์กอัปที่มีน้ำหนักเบาออกแบบมาเพื่อให้ข้อความธรรมดาอ่านและเขียนได้ง่าย ในขณะเดียวกันก็ช่วยให้แปลงเป็น HTML ได้อย่างง่ายดาย ในทางปฏิบัติ หมายความว่าคุณสามารถเขียนข้อความปกติและเพิ่มอักขระพิเศษเพียงไม่กี่ตัวเพื่อสร้างหัวข้อ รายการ ตาราง คำพูด โค้ดที่จัดรูปแบบ ลิงก์ หรือรูปภาพได้
บน GitHub นั้น ระบบที่ใช้คือ GitHub Flavored Markdown (GFM) ซึ่งขยายไวยากรณ์แบบคลาสสิกด้วยตาราง รายการสิ่งที่ต้องทำ การเน้นโค้ดขั้นสูง การรองรับสี การแจ้งเตือน และแท็ก HTML ที่อนุญาตบางส่วนทั้งหมดนี้จะถูกแสดงผลโดยอัตโนมัติในไฟล์ .md และในช่องแสดงความคิดเห็นของแพลตฟอร์ม
Reddit ใช้โปรแกรมแก้ไขข้อความของตัวเองที่เรียกว่า Snoomark ซึ่งเป็นโปรแกรมที่พัฒนามาจาก GFM มันมีพฤติกรรมพื้นฐานหลายอย่างเหมือนกัน (ตัวหนา ตัวเอียง หัวข้อ รายการ คำพูด โค้ดแบบอินไลน์หรือแบบบล็อก ลิงก์ ฯลฯ) แต่ก็มีคุณสมบัติเฉพาะที่สำคัญอยู่บ้างเช่น การรองรับรูปภาพมีข้อจำกัดมากกว่า ขึ้นอยู่กับบริบท และมันยังเพิ่มองค์ประกอบเฉพาะของตัวเอง เช่น สปอยล์
ข้อดีของเรื่องนี้คือ ด้วยไวยากรณ์เพียงแบบเดียว คุณสามารถเขียนข้อความที่ดูดีได้ทั้งบน GitHub และ Reddit โดยปรับเปลี่ยนเพียงรายละเอียดเล็กน้อยในส่วนที่แต่ละแพลตฟอร์มทำงานแตกต่างกันการเรียนรู้กฎพื้นฐานจะช่วยให้คุณใช้งานได้ง่ายทั้งสองแพลตฟอร์มโดยไม่ต้องเรียนรู้ใหม่ทั้งหมด
หัวข้อและโครงสร้างเนื้อหา
หนึ่งในสิ่งแรกๆ ที่คุณจะใช้คือหัวข้อทั้งบน GitHub และ Reddit หัวข้อช่วยจัดโครงสร้างข้อความให้เป็นส่วนๆ และส่วนย่อยๆ
ใน Markdown การสร้างหัวข้อจะทำได้โดยการใส่เครื่องหมายแฮช (#) หนึ่งถึงหกตัวนำหน้าข้อความ: หนึ่งตัวสำหรับหัวข้อระดับ 1 สองตัวสำหรับระดับ 2 และเพิ่มขึ้นเรื่อย ๆ จนถึงระดับ 6 ตัวอย่างเช่น ในไฟล์ README.md ของ GitHub คุณอาจมีข้อความประมาณนี้: # หัวข้อหลัก , ## ส่วน , ### ส่วนย่อย , เป็นต้น
เมื่อ GitHub พบหัวข้อตั้งแต่สองหัวข้อขึ้นไปในไฟล์ ระบบจะสร้างสารบัญ โดยอัตโนมัติ ซึ่งสามารถเข้าถึงได้จากไอคอน "โครงร่าง" ที่ด้านบนของไฟล์ หัวข้อแต่ละหัวข้อจะปรากฏเป็นลิงก์ที่จะนำคุณไปยังส่วนนั้นโดยตรง ซึ่งเหมาะสำหรับเอกสารขนาดยาว
นอกจากนี้ หัวข้อแต่ละหัวข้อจะกลายเป็นจุดเชื่อมโยงภายในที่คุณสามารถเชื่อมโยงได้ด้วยส่วนย่อยของ URL ที่อิงจากข้อความในชื่อเรื่อง เพื่อสร้างส่วนย่อยนั้น GitHub จะใช้กฎที่เฉพาะเจาะจงมาก ได้แก่ การแปลงตัวอักษรเป็นตัวพิมพ์เล็ก แทนที่ช่องว่างด้วยเครื่องหมายยัติภังค์ ลบเครื่องหมายวรรคตอนและอักขระจัดรูปแบบ (เช่น ตัวเอียง) ตัดช่องว่างส่วนเกิน และหากผลลัพธ์ตรงกับหัวข้อก่อนหน้าจะเพิ่มตัวเลขต่อท้าย (-1, -2 เป็นต้น) เพื่อให้ไม่ซ้ำกัน
วิธีนี้ช่วยให้คุณสามารถทำสิ่งต่างๆ ได้ เช่น วาง## ตัวอย่าง ส่วน แล้วเชื่อมโยงไปยังส่วนนั้นจากจุดอื่นในเอกสารด้วยลิงก์เช่น(#sample-section)หรือแม้แต่เชื่อมโยงไปยังส่วนที่มีอักขระพิเศษในชื่อ เนื่องจาก GitHub สร้างโค้ดตัวอย่างตามกฎเหล่านั้นและทำให้สามารถเข้าถึงได้ด้วยรูปแบบเดียวกัน
การเน้นข้อความ, ข้อความที่ไฮไลต์ และคำพูดอ้างอิง
Markdown ช่วยให้คุณเน้นข้อความโดยใช้รูปแบบการเน้น ต่างๆ ได้ เช่น ตัวหนา ตัวเอียง ขีดฆ่า ตัวห้อย ตัวยก หรือขีดเส้นใต้ บน GitHub ตารางสไตล์ทั่วไปจะมีลักษณะเช่นนี้ แม้ว่าเราจะสรุปไว้ที่นี่ในรูปแบบที่แตกต่างออกไปก็ตาม:
ในการทำให้ข้อความตัวหนาให้ใช้เครื่องหมายดอกจันคู่หรือขีดเส้นใต้คู่ล้อมรอบข้อความนั้น สำหรับตัวเอียง ให้ใช้เครื่องหมายดอกจันเดี่ยวหรือขีดเส้นใต้เดี่ยว สำหรับขีดฆ่า ให้ใช้เครื่องหมายทิลเดคู่ (สองตัว) วางไว้ทั้งสองด้านของข้อความ คุณยังสามารถรวมตัวหนาและตัวเอียงเข้าด้วยกันได้ โดยใช้เครื่องหมายดอกจันสามตัวเพื่อใช้ทั้งสองอย่างกับข้อความทั้งหมด หรือใช้แท็ก HTML เช่น `<b>` สำหรับตัวห้อยและตัวยก และ `<i>` สำหรับขีดเส้นใต้
GitHub ยังอนุญาตให้คุณสร้างข้อความอ้างอิงแบบบล็อกโดยการวางสัญลักษณ์มากกว่า (>) ไว้ที่ต้นบรรทัด ข้อความอ้างอิงจะแสดงโดยมีแถบแนวตั้งทางด้านซ้ายและเป็นสีเทา ทำให้มองเห็นได้ชัดเจน คุณสามารถมีหลายบรรทัดภายในบล็อกอ้างอิงเดียวกัน และยังสามารถซ้อนข้อความอ้างอิงได้โดยการเพิ่มสัญลักษณ์ > เพิ่มเติมที่ต้นบรรทัด
รูปแบบการอ้างอิงขั้นสูงเฉพาะของ GitHub คือ การแจ้งเตือนหรือคำตักเตือนโดยใช้ไวยากรณ์การอ้างอิงแบบบล็อกข้อความเหมือนกัน แต่บรรทัดแรกจะมีเครื่องหมายพิเศษเพื่อระบุประเภทของการแจ้งเตือน ตัวอย่างเช่น คุณสามารถระบุ `alert` สำหรับข้อมูลที่เป็นประโยชน์ `เคล็ดลับที่เป็นประโยชน์` `ข้อมูลสำคัญ` `คำเตือนเร่งด่วน` และ `คำเตือนเกี่ยวกับความเสี่ยงหรือผลกระทบเชิงลบ` GitHub จะแสดงแต่ละประเภทด้วยสีและไอคอนที่แตกต่างกัน ช่วยเน้นข้อมูลสำคัญในเอกสารของคุณ
Reddit ก็รองรับการอ้างอิงข้อความแบบง่ายๆ ด้วยสัญลักษณ์ > เช่นกัน แม้ว่าจะขาดระบบการแจ้งเตือนที่ครบครันเหมือน GitHub ก็ตาม ถึงกระนั้น มันก็ยังคงเป็นวิธีที่ใช้งานได้ดีมากในการตอบกลับผู้อื่นโดยการอ้างอิงส่วนหนึ่งของข้อความของพวกเขาโดยไม่ต้องเขียนซ้ำทั้งหมด
การเน้นโค้ด, บล็อก และสี
ทั้ง GitHub และ Reddit อนุญาตให้คุณเน้นโค้ดที่อยู่ภายในข้อความโดยใช้เครื่องหมายแบ็กติ๊ก (`) สำหรับโค้ดที่แทรกอยู่ในข้อความ คุณจะต้องใส่เครื่องหมายแบ็กติ๊กหนึ่งตัวคร่อมคำหรือคำสั่งนั้นไว้ทั้งสองด้าน วิธีนี้เหมาะสำหรับการเน้นข้อความ เช่น ` git status`ภายในประโยค เพื่อให้เห็นชัดเจนว่าเป็นคำสั่ง
เมื่อต้องการเขียนโค้ดเป็นส่วนๆ แยกต่างหาก Markdown จะใช้เครื่องหมายแบ็กติ๊กสามตัว: คุณเขียนบรรทัดด้วยเครื่องหมายแบ็กติ๊กสามตัว จากนั้นเขียนโค้ดในบรรทัดแยกกัน และปิดท้ายด้วยเครื่องหมายแบ็กติ๊กอีกสามตัว ใน GitHub หากคุณระบุภาษาไว้หลังเครื่องหมายแบ็กติ๊กตัวแรกการเน้นไวยากรณ์ด้วยสีและการจัดรูปแบบเฉพาะของภาษานั้นจะถูกนำมาใช้
GitHub ยังมีฟีเจอร์เฉพาะสำหรับการเน้นค่าสีภายในเครื่องหมายแบ็กติ๊ก (`) ด้วย หากคุณพิมพ์สีในรูปแบบเลขฐานสิบหก, RGB หรือ HSL ระหว่างเครื่องหมายแบ็กติ๊ก แพลตฟอร์มจะแสดงตัวบ่งชี้สีขนาดเล็กถัดจากข้อความ ตัวอย่างเช่น หากสีพื้นหลังในโหมดสว่างคือ #ffffff และในโหมดมืดคือ #000000 การเน้นรหัสเหล่านี้จะช่วยให้คุณเห็นได้อย่างรวดเร็วว่าอันไหนเป็นอันไหน
ในส่วนของการแสดงโค้ดและตาราง GitHub อนุญาตให้คุณเลือกใช้ฟอนต์แบบ monospace คงที่ในช่องแสดงความคิดเห็นทั้งหมด ซึ่งจะช่วยให้การทำงานกับข้อความทางเทคนิคทำได้ง่ายขึ้น หากคุณแก้ไขโค้ดจำนวนมากในเบราว์เซอร์หรือในโปรแกรมแก้ไขข้อความ เช่นVisual Studio Codeการเปิดใช้งานตัวเลือกนี้จะทำให้การจัดเรียงและการอ่านง่ายมีความสม่ำเสมอมากขึ้น
นอกจากนี้ Reddit ยังรองรับบล็อกโค้ดที่มีเครื่องหมายแบ็กติ๊ก ทั้งแบบแทรกในบรรทัดและแบบบล็อก แม้ว่าการใช้งานบน Reddit จะเน้นไปที่โค้ดตัวอย่างขนาดเล็กหรือรหัสเทียมมากกว่าเอกสารขนาดยาวอย่างเช่นในคลังเก็บข้อมูลก็ตาม
การสร้างลิงก์ใน Markdown นั้นง่ายมาก: คุณเพียงแค่ใส่ข้อความที่จะแสดงให้ผู้ใช้เห็นไว้ในวงเล็บเหลี่ยม และใส่ URL ไว้ในวงเล็บ วิธีนี้ใช้ได้ทั้งบน GitHub และ Reddit และสามารถเพิ่มความสะดวกสบายด้วยคีย์ลัดบน GitHub (เช่น การใช้คีย์ผสมเพื่อแปลงข้อความที่เลือกเป็นลิงก์อย่างรวดเร็ว)
GitHub เพิ่มฟีเจอร์เพิ่มเติมที่เกี่ยวข้องกับการนำทาง ประการแรก ช่วยให้คุณสามารถเชื่อมโยงไปยังหัวข้อโดยตรงโดยใช้กฎการสร้างสนิปเป็ตที่กล่าวถึงไปก่อนหน้านี้ ประการที่สอง รองรับการเชื่อมโยงแบบสัมพัทธ์ภายในที่เก็บข้อมูลเอง ซึ่งมีความสำคัญอย่างยิ่งสำหรับเอกสารทางเทคนิค
ลิงก์แบบสัมพัทธ์คือลิงก์ที่คำนวณโดยใช้ไฟล์ปัจจุบันเป็นจุดอ้างอิง ตัวอย่างเช่น หากไฟล์ README ของคุณอยู่ในไดเร็กทอรีหลักของโปรเจ็กต์ และคุณต้องการเชื่อมโยงไปยังไฟล์ docs/CONTRIBUTING.md คุณก็เพียงแค่เขียนลิงก์โดยใช้พาธ docs/CONTRIBUTING.md GitHub จะจัดการการแปลงลิงก์แบบสัมพัทธ์นี้อย่างถูกต้องในทุกสาขาที่คุณใช้งานอยู่ ป้องกันไม่ให้ลิงก์เสียหายเมื่อเปลี่ยนสาขาหรือโคลนที่เก็บข้อมูล
คำแนะนำคือควรใช้พาธสัมพัทธ์ เสมอ เมื่อนำทางระหว่างไฟล์ในที่เก็บเดียวกัน เนื่องจากลิงก์แบบสัมบูรณ์อาจใช้งานไม่ได้ในสำเนาหรือฟอร์กของโปรเจกต์ GitHub อนุญาตให้ใช้ตัวดำเนินการมาตรฐาน เช่น ./ หรือ ../ และพาธที่ขึ้นต้นด้วย / เทียบกับรากของโปรเจกต์
หากคุณต้องการสร้างจุดเชื่อมโยงแบบกำหนดเองภายในเอกสารนอกเหนือจากหัวข้อ คุณสามารถใช้แท็ก HTML ที่มีแอตทริบิวต์ `name` ได้ วิธีนี้ช่วยให้คุณสามารถวางจุดเป้าหมายไว้ตรงกลางย่อหน้าหรือถัดจากข้อความที่ไม่มีชื่อเรื่อง และเชื่อมโยงไปยังจุดนั้นโดยใช้ไวยากรณ์เดียวกับหัวข้อที่สร้างขึ้นโดยอัตโนมัติ
รูปภาพบน GitHub: Markdown, HTML และเส้นทางสัมพัทธ์
ใน GitHub การฝังรูปภาพโดยทั่วไปจะใช้ไวยากรณ์เดียวกับการฝังลิงก์ แต่จะมีเครื่องหมายอัศเจรีย์นำหน้า ข้อความทางเลือก (alt) จะระบุไว้ในวงเล็บเหลี่ยม และ URL หรือเส้นทางไปยังรูปภาพจะอยู่ในวงเล็บ ข้อความทางเลือกนี้มีความสำคัญต่อการเข้าถึงได้ ง่าย เนื่องจากเป็นสิ่งที่โปรแกรมอ่านหน้าจอจะอ่านและจะแสดงขึ้นหากรูปภาพโหลดไม่สำเร็จ
รูปภาพสามารถมาจากไฟล์ภายในที่เก็บข้อมูลเองหรือจาก URL ภายนอกได้ GitHub อนุญาตให้ใช้รูปแบบเส้นทางสัมพัทธ์หลายแบบสำหรับการอัปโหลดรูปภาพจากสาขาต่างๆ ที่เก็บข้อมูลอื่นๆ หรือแม้แต่จากปัญหาและความคิดเห็น โดยใช้คำต่อท้ายเช่น?raw=trueเพื่อบังคับให้ดาวน์โหลดไฟล์โดยตรงเมื่อจำเป็น
นอกเหนือจากไวยากรณ์ Markdown มาตรฐานแล้ว GitHub ยังรองรับการใช้แท็ก HTML `<picture>` ด้วย แท็กนี้มีประโยชน์อย่างยิ่งสำหรับการโหลดรูปภาพที่ปรับเปลี่ยนได้ตามการตั้งค่าธีมของผู้ใช้ (สว่างหรือมืด) โดยใช้ media query `prefers-color-scheme` คุณสามารถกำหนดแหล่งที่มาของรูปภาพที่แตกต่างกันสำหรับแต่ละโหมด และรูปภาพเริ่มต้นสำหรับเบราว์เซอร์ที่ไม่รองรับคุณสมบัตินี้ได้
รูปแบบทั่วไปเกี่ยวข้องกับการรวมไว้ภายใน องค์ประกอบหลายอย่าง พร้อมด้วยแอตทริบิวต์ media และ srcset และสุดท้ายคือ การใช้แอตทริบิวต์ alt และ URL ทั่วไป จะช่วยให้ผู้ใช้ในโหมดมืดเห็นภาพที่ปรับเปลี่ยน ในขณะที่ผู้ใช้ในโหมดสว่างจะได้รับภาพที่แตกต่างออกไป โดยไม่ต้องคัดลอกเนื้อหาในไฟล์ README ซ้ำซ้อน
GitHub ยังรองรับการใส่ความคิดเห็นในรูปแบบ HTML ในไฟล์ Markdown ซึ่งช่วยให้คุณสามารถเพิ่มข้อความเตือนที่มองไม่เห็นให้กับผู้อ่านได้ เช่น เพื่อเตือนให้พวกเขาอัปเดตส่วนรูปภาพหรือเพิ่มตัวอย่างใหม่ในภายหลัง
ตาราง ส่วนที่พับได้ และการแบ่งเนื้อหา
หนึ่งในฟีเจอร์ที่มีประโยชน์ที่สุดใน GitHub Flavored Markdown คือ การรองรับ ตารางคุณสามารถจัดระเบียบข้อมูลเป็นแถวและคอลัมน์โดยใช้เส้นแนวตั้งเพื่อแยกเซลล์ และใช้เส้นประเพื่อทำเครื่องหมายส่วนหัว นอกจากนี้ยังสามารถจัดแนวคอลัมน์ไปทางขวา ซ้าย หรือตรงกลางได้โดยใช้เครื่องหมายโคลอนในแถวคั่น
ตารางมีประโยชน์มากสำหรับการนำเสนอรายการภาษาโปรแกรม เฟรมเวิร์กที่ใช้ งานที่วางแผนไว้ การเปรียบเทียบคุณสมบัติ หรือข้อมูลอื่น ๆ ที่ได้รับประโยชน์จากโครงสร้างแบบเมทริกซ์ GitHub แสดงผลตารางเหล่านี้ด้วยรูปแบบที่สะอาดตาและอ่านง่าย
เพื่อให้ไฟล์ README ที่ยาวเป็นระเบียบ คุณสามารถใช้แท็ก HTML `<details>` เพื่อสร้างส่วนที่สามารถพับเก็บได้ ส่วนเหล่านี้จะแสดงสรุปภายในแท็ก `<summary>` และอนุญาตให้ผู้ใช้ขยายหรือพับเนื้อหาเพิ่มเติมได้ตามต้องการ เป็นเรื่องปกติที่จะใส่ตารางหรือบล็อกข้อมูลรองไว้ภายใน `<details>` เพื่อไม่ให้ผู้ใช้รู้สึกว่าข้อมูลมากเกินไปตั้งแต่แรกเห็น
หากคุณต้องการให้ส่วนนั้นแสดงผลแบบขยายโดยค่าเริ่มต้น เพียงแค่เพิ่มแอตทริบิวต์ open เข้าไป เทคนิคนี้มีประโยชน์มากสำหรับการจัดกลุ่มการจัดอันดับ รายการยาวๆ หรือเนื้อหาที่ไม่จำเป็นสำหรับการอ่านครั้งแรก แต่สะดวกที่จะเข้าถึงได้ง่าย
อีกหนึ่งเครื่องมือที่ง่ายสำหรับการจัดระเบียบข้อมูลคือเส้นแบ่งแนวนอน ซึ่งสร้างขึ้นโดยการเขียนขีดสามขีดขึ้นไปบนเส้นเดียว และใช้เพื่อแบ่งส่วนต่างๆ ออกจากกัน ทำให้คุณสามารถแยกส่วนต่างๆ ได้อย่างชัดเจน เช่น ส่วนคำอธิบายออกจากส่วนอ้างอิงหรือหมายเหตุเพิ่มเติม
กฎเหล่านี้สามารถนำไปใช้ร่วมกับคำคมท้ายเอกสารเพื่อเน้นวลีสร้างแรงบันดาลใจ ข้อเตือนใจ หรือข้อความสำคัญได้ ตัวอย่างทั่วไปคือการวางคำคมสร้างแรงบันดาลใจไว้ท้ายไฟล์ README ของโปรไฟล์ของคุณ โดยจัดรูปแบบเป็นข้อความอ้างอิงแบบบล็อกหลังจากเส้นคั่น
ซ่อนความคิดเห็นและการควบคุมรูปแบบ
GitHub อนุญาตให้คุณแทรกความคิดเห็น HTMLภายใน Markdown โดยใช้ไวยากรณ์ <!-- comment --> สิ่งที่คุณใส่ไว้ในความคิดเห็นนั้นจะไม่แสดงในเนื้อหาที่แสดงผล แต่จะมองเห็นได้ในซอร์สโค้ด ทำให้เหมาะสำหรับบันทึกภายในหรือรายการสิ่งที่ต้องทำ
ตัวอย่างเช่น ในไฟล์ README ของโปรไฟล์ คุณสามารถเพิ่มความคิดเห็นที่ระบุว่าคุณจำเป็นต้องขยายส่วน "เกี่ยวกับฉัน" ในภายหลัง หรือคุณจำเป็นต้องตรวจสอบตารางเทคโนโลยีที่ล้าสมัย โดยที่ผู้ที่เข้าชมโปรไฟล์จะไม่เห็นความคิดเห็นนั้นโดยตรง
อีกหนึ่งคุณสมบัติที่มีประโยชน์คือการหลีกเลี่ยงอักขระที่ปกติจะถูกตีความว่าเป็น Markdown หากคุณต้องการแสดงเครื่องหมายดอกจัน เครื่องหมายแฮช หรือสัญลักษณ์อื่นๆ โดยไม่ให้มีการจัดรูปแบบ เพียงแค่ใส่เครื่องหมายแบ็กสแลชนำหน้าแต่ละสัญลักษณ์ วิธีนี้ช่วยให้คุณสามารถเขียนนิพจน์ที่มีสัญลักษณ์รายการได้โดยไม่ต้องแปลงเป็นรายการจริง
เมื่อคุณดูไฟล์มาร์กอัปบน GitHub คุณจะมีตัวเลือกในการสลับระหว่างมุมมองที่แสดงผลและซอร์สโค้ดด้วยปุ่มที่ด้านบน (หรือเปิดในโปรแกรมแก้ไขเช่นBrackets ) การปิดใช้งานการตีความมาร์กอัปจะช่วยให้คุณเข้าถึงคุณสมบัติการดูโค้ดทั่วไป เช่นการเชื่อมโยงบรรทัดเฉพาะซึ่งมีประโยชน์มากเมื่อคุณต้องการเน้นส่วนใดส่วนหนึ่งของไฟล์ README หรือไฟล์ .md ใดๆ
สุดท้ายนี้ โปรดจำไว้ว่า GitHub จัดการกับการขึ้นบรรทัดใหม่แตกต่างกันในความคิดเห็น (ปัญหา, คำขอรวมโค้ด ฯลฯ) และในไฟล์ Markdown ในความคิดเห็น ระบบจะเคารพการขึ้นบรรทัดใหม่โดยตรง ในขณะที่ในไฟล์ Markdown คุณต้องเพิ่มช่องว่างสองช่องที่ท้ายบรรทัด เครื่องหมายแบ็กสแลช หรือจุด เพื่อบังคับให้เกิดการข้ามไปยังส่วนอื่นภายในย่อหน้าเดียวกัน
รายการ, รายการย่อย และรายการสิ่งที่ต้องทำ
รายการเป็นหนึ่งในองค์ประกอบที่ใช้บ่อยที่สุดใน Markdown ทั้งบน GitHub และ Reddit คุณสามารถสร้าง รายการ ที่ไม่เรียงลำดับได้โดยการใส่เครื่องหมายขีดกลาง เครื่องหมายดอกจัน หรือเครื่องหมายบวกนำหน้าแต่ละรายการ เครื่องหมายเหล่านี้จะแสดงผลคล้ายกับจุดนำหน้า
ในการสร้าง รายการที่มีลำดับ ให้กำหนดหมายเลขให้กับแต่ละบรรทัดด้วยตัวเลข ตามด้วยจุด และเว้นวรรค ลำดับของตัวเลขไม่จำเป็นต้องสมบูรณ์แบบ (โดยปกติ GitHub จะคำนวณใหม่เอง) แต่การรักษาลำดับหมายเลขให้สม่ำเสมอจะช่วยให้โค้ดอ่านง่ายขึ้น
การสร้างรายการแบบซ้อนกันทำได้ง่ายๆ โดยการเว้นวรรครายการด้านล่าง ในโปรแกรมแก้ไขข้อความแบบตัวอักษรคงที่ เช่นSublime Textคุณเพียงแค่ต้องจัดตำแหน่งตัวคั่นรายการแบบซ้อนกันให้ตรงกับตัวอักษรตัวแรกของข้อความในรายการหลัก ในบริบทอย่างเช่นโปรแกรมแก้ไขความคิดเห็นของ GitHub ซึ่งแบบอักษรไม่ใช่แบบตัวอักษรคงที่ คุณควรนับจำนวนตัวอักษรที่อยู่ก่อนหน้าข้อความและใช้จำนวนช่องว่างนั้นสำหรับการเว้นวรรค
คุณสามารถสร้างโครงสร้างการซ้อนกันหลายระดับได้ ตราบใดที่จำนวนช่องว่างยังคงสม่ำเสมอ สำหรับรายการที่ซับซ้อนมาก ระบบนี้อาจต้องอาศัยการฝึกฝนเล็กน้อย แต่เมื่อคุณเข้าใจแล้ว ก็จะสามารถนำไปใช้ได้อย่างรวดเร็ว
GitHub ยังมีรายการงาน (Task List ) ซึ่งมีประโยชน์มากสำหรับปัญหา (Issue) คำขอรวมโค้ด (Pull Request) และเอกสารต่างๆ วิธีการสร้างรายการงานคือ นำหน้าด้วยเครื่องหมายขีด (-) เว้นวรรค และวงเล็บเหลี่ยมสองอัน โดยด้านในวงเล็บเหลี่ยมจะมีเว้นวรรคหรือเครื่องหมาย "x" อยู่ อันหนึ่งสำหรับงานที่ยังไม่เสร็จ และอีกอันสำหรับงานที่เสร็จแล้ว รายการเหล่านี้จะมีช่องทำเครื่องหมายให้เลือกหรือยกเลิกการเลือกได้จากส่วนติดต่อผู้ใช้
หากข้อความของรายการสิ่งที่ต้องทำขึ้นต้นด้วยวงเล็บ จะต้องใช้เครื่องหมายแบ็กสแลช (/) เพื่อหลีกเลี่ยงความสับสนในการวิเคราะห์ข้อความ นี่เป็นรายละเอียดเล็กน้อย แต่สำคัญเมื่อเขียนคำอธิบายที่ขึ้นต้นด้วยข้อความเช่น "(ตัวเลือก)" หรือข้อความที่คล้ายกัน
การกล่าวถึง การอ้างอิง และอีโมจิบน GitHub
ข้อดีอย่างหนึ่งของการเขียนด้วย Markdown บน GitHub คือความสามารถในการกล่าวถึงผู้ใช้และทีมบนแพลตฟอร์มโดยตรง คุณเพียงแค่พิมพ์ @ ตามด้วยชื่อผู้ใช้หรือชื่อทีม และ GitHub จะส่งการแจ้งเตือนไปยังบัญชีนั้น เพื่อดึงความสนใจของพวกเขามาที่บทสนทนา
เมื่อคุณพิมพ์สัญลักษณ์ @ GitHub จะแสดงรายชื่อผู้ใช้และทีมที่เกี่ยวข้องกับ repository หรือ thread นั้น และคุณสามารถกรองรายชื่อนี้ได้ขณะพิมพ์ ใช้ปุ่มลูกศรและกด Enter หรือ Tab เพื่อยอมรับคำแนะนำ สำหรับทีม ให้ใช้รูปแบบ @organization/team-name และสมาชิกทีมทั้งหมดจะได้รับการติดตาม thread นั้น
นอกจากการกล่าวถึงแล้ว GitHub ยังทำให้การอ้างอิงถึงปัญหาและคำขอแก้ไขโค้ด ทำได้ง่าย เพียงแค่พิมพ์ # ตามด้วยตัวเลขหรือส่วนหนึ่งของชื่อเรื่อง รายการผลลัพธ์ที่แนะนำจะปรากฏขึ้น ซึ่งคุณสามารถกรอกข้อมูลให้ครบถ้วนได้ในลักษณะเดียวกับการกล่าวถึง วิธีนี้ช่วยเพิ่มความเร็วในการค้นหาข้อมูลระหว่างการสนทนาที่เกี่ยวข้องได้อย่างมาก
หากคลังข้อมูลของคุณมีการตั้งค่าการอ้างอิงแบบเชื่อมโยงอัตโนมัติที่กำหนดเองไว้ สัญลักษณ์ภายนอกบางอย่าง (เช่น รหัสตั๋ว JIRA หรือ Zendesk) อาจถูกแปลงเป็นลิงก์สั้นโดยอัตโนมัติเช่นกัน การตั้งค่านี้ต้องใช้สิทธิ์ผู้ดูแลระบบ แต่เมื่อเปิดใช้งานแล้ว จะช่วยให้สามารถแชร์ข้อมูลข้ามระบบได้โดยใช้ความพยายามน้อยที่สุด
สุดท้ายนี้ GitHub รองรับการใช้ emoji ผ่านโค้ด: พิมพ์เครื่องหมายโคลอน ตามด้วยชื่อ emoji และปิดท้ายด้วยเครื่องหมายโคลอนอีกครั้ง เมื่อคุณเริ่มพิมพ์ รายการ emoji ที่แนะนำจะปรากฏขึ้น ซึ่งคุณสามารถเลือกยอมรับได้โดยการกด Tab หรือ Enter การใส่ emoji ลงในความคิดเห็นจะช่วยให้ความคิดเห็นดูเป็นธรรมชาติมากขึ้น ตราบใดที่คุณไม่ใช้ emoji มากเกินไปในเอกสารที่เป็นทางการ
เชิงอรรถและเนื้อหาขั้นสูง
GitHub ยังรองรับการอ้างอิงเชิงอรรถโดยใช้ไวยากรณ์แบบวงเล็บเหลี่ยมและตัวระบุที่มีเครื่องหมายแคเร็ต โดยในจุดที่คุณต้องการอ้างอิง ให้แทรกแท็กเช่น `<footnote>` และในตอนท้ายของเอกสาร ให้กำหนดข้อความของเชิงอรรถนั้นด้วยแท็กเดียวกัน ตามด้วยเครื่องหมายโคลอนและเนื้อหา
เชิงอรรถสามารถครอบคลุมได้หลายบรรทัด และเพื่อให้เกิดการขึ้นบรรทัดใหม่ภายในเชิงอรรถ จะใช้การเว้นวรรคสองครั้งที่ท้ายบรรทัด เช่นเดียวกับในเนื้อหาหลักของ Markdown เมื่อแสดงผล GitHub จะแสดงตัวยกบนข้อความและรายการเชิงอรรถที่ท้ายสุด พร้อมลิงก์ย้อนกลับเพื่อนำทางระหว่างเอกสารอ้างอิงและเชิงอรรถ
อีกหนึ่งฟีเจอร์ขั้นสูงที่ GitHub นำเสนอคือการแจ้งเตือนต่างๆ ที่กล่าวถึงไปแล้ว (NOTE, TIP, IMPORTANT, WARNING และ CAUTION) แนะนำให้ใช้เฉพาะเมื่อจำเป็นจริงๆ และหลีกเลี่ยงการใช้การแจ้งเตือนหลายๆ อย่างติดกันเพื่อป้องกันไม่ให้ผู้อ่านรู้สึกว่าได้รับข้อมูลมากเกินไป การแจ้งเตือนเหล่านี้ไม่สามารถซ้อนอยู่ภายในองค์ประกอบที่ซับซ้อนอื่นๆ ได้ ดังนั้นการวางแผนอย่างรอบคอบจึงเป็นสิ่งสำคัญในการจัดวาง
สุดท้ายนี้ คุณสามารถขอให้ GitHub ซ่อนส่วนต่างๆ ของ Markdown ที่แสดงผลชั่วคราวได้โดยการครอบด้วยความคิดเห็น HTML หรือละเว้นการประมวลผลอักขระบางตัวด้วยเครื่องหมายแบ็กสแลช วิธีนี้มีประโยชน์อย่างยิ่งเมื่อคุณกำลังจัดทำเอกสารเกี่ยวกับไวยากรณ์ของ Markdown เองและต้องการแสดงตัวอย่างตามที่เป็นอยู่โดยไม่ต้องมีการตีความ
Markdown บน Reddit: Snoomark และโหมดการแก้ไข
Reddit เป็นแพลตฟอร์มสนทนาที่เปิดรับแทบทุกหัวข้อ โดยจัดระเบียบเป็นซับเรดดิต ในแง่ของการจัดรูปแบบ มีตัวแก้ไขสองแบบ: แบบหนึ่งสำหรับข้อความที่มีรูปแบบสวยงาม และอีกแบบสำหรับข้อความธรรมดาโดยใช้ Markdown หากคุณต้องการทำงานอย่างรวดเร็วและควบคุมผลลัพธ์ได้อย่างละเอียด คุณควรใช้ตัวเลือก Markdown
โดยปกติแล้ว Reddit จะเปิดใช้งานโหมดแก้ไขข้อความแบบ Rich Text Editor ดังนั้นหากต้องการเปลี่ยนไปใช้โหมด Markup คุณต้องคลิก ตัวเลือก โหมด Markdownภายในช่องข้อความของโพสต์หรือความคิดเห็น จากนั้นคุณสามารถใช้ไวยากรณ์ Snoomark ได้โดยตรง
หากคุณต้องการให้โปรแกรมแก้ไข Markdown โหลดทุกครั้ง ให้ไปที่การตั้งค่าผู้ใช้ เข้าสู่ส่วนการตั้งค่าฟีด และเปิดใช้งานตัว เลือก "ตั้งค่าเริ่มต้นเป็น Markdown"วิธีนี้ โปรแกรมแก้ไข Markdown จะเปิดขึ้นโดยอัตโนมัติทุกครั้งที่คุณเริ่มเขียนโพสต์หรือความคิดเห็น โดยที่คุณไม่ต้องเปลี่ยนด้วยตนเอง
Reddit รองรับคุณสมบัติ Markdown ขั้นพื้นฐานและขั้นสูงส่วนใหญ่ เช่น หัวข้อ ตัวหนาและตัวเอียง รายการ คำพูดอ้างอิง บล็อกโค้ด ลิงก์ และคุณสมบัติพิเศษบางอย่าง เช่น สปอยล์ อย่างไรก็ตาม มันมีข้อจำกัดที่สำคัญเมื่อเทียบกับ GitHub โดยเฉพาะอย่างยิ่งในการจัดการรูปภาพซึ่งขึ้นอยู่กับบริบทและประเภทของโปรแกรมแก้ไขเป็นอย่างมาก
ไวยากรณ์ที่รองรับโดย Reddit และสปอยล์
รูปแบบ Snoomark ที่ Reddit ใช้มีองค์ประกอบหลายอย่างที่คล้ายคลึงกับ GitHub ดังนั้นหากคุณมีความเชี่ยวชาญในการใช้ Markdown สำหรับการจัดการคลังข้อมูลอยู่แล้ว การถ่ายทอดความรู้เหล่านั้นไปยังสภาพแวดล้อมของ Reddit จึงค่อนข้างง่าย คุณสามารถใช้หัวข้อเพื่อจัดโครงสร้างโพสต์ยาวๆ รายการแบบมีหมายเลขหรือแบบจุด การอ้างอิงเพื่อตอบกลับผู้ใช้รายอื่น และบล็อกโค้ดเมื่อคุณต้องการแสดงคำสั่งหรือข้อมูลทางเทคนิค
หนึ่งในความแตกต่างที่เห็นได้ชัดคือวิธีที่ Reddit จัดการกับรูปภาพแม้ว่าในหลายกรณี รูปภาพจะถูกอัปโหลดผ่านทางอินเทอร์เฟซแบบกราฟิกและไม่ได้ใช้ไวยากรณ์ Markdown โดยตรง แต่เครื่องมือที่ประมวลผลเนื้อหาข้อความก็ยังคงเป็น Snoomark ดังนั้นการจัดรูปแบบรอบๆ รูปภาพเหล่านั้นจึงอิงตาม Markdown นั่นเอง
ในทางกลับกัน Reddit เพิ่มคุณสมบัติพิเศษที่ไม่ได้รวมอยู่ในข้อกำหนดมาตรฐาน เช่น สปอยล์ ซึ่งช่วยให้สามารถซ่อนข้อความไว้หลังเลเยอร์ที่ผู้ใช้สามารถเปิดเผยได้ด้วยการคลิก ในทางเทคนิคแล้ว เมื่อ Reddit ประมวลผลสปอยล์ มันจะแปลงเป็นส่วนผสมของ HTML, คลาส CSS และ JavaScript เฉพาะแพลตฟอร์ม
โครงสร้าง HTML ของสปอยเลอร์ที่ได้นั้นจะมีตัวจัดการที่ควบคุมว่าจะแสดงหรือซ่อนเนื้อหาเมื่อใด และในทางทฤษฎีแล้วเราสามารถเขียนสิ่งที่คล้ายกันได้ด้วย HTML ธรรมดา แต่ใน Reddit นั้นขึ้นอยู่กับการทำงานภายในของระบบ สิ่งสำคัญสำหรับคุณในฐานะผู้ใช้คือ เมื่อเขียน คุณเพียงแค่ต้องใช้ไวยากรณ์สปอยเลอร์เฉพาะที่โปรแกรมแก้ไขจัดเตรียมไว้ให้ และSnoomark จะจัดการแปลงให้เป็นโครงสร้างที่เหมาะสมให้เอง
กล่าวโดยสรุป Snoomark สืบทอดพฤติกรรมหลายอย่างมาจาก GitHub Flavored Markdown แต่ปรับให้เหมาะสมกับความต้องการของชุมชนสนทนามากกว่าเอกสารประกอบโครงการ ถึงกระนั้น แก่นหลักก็ยังคงเหมือนเดิม คือ การแปลงข้อความธรรมดาที่มีสัญลักษณ์ง่ายๆ ให้เป็นเนื้อหาที่มีโครงสร้างและอ่านง่าย
การเรียนรู้ไวยากรณ์ Markdown บน GitHub และ Reddit จะช่วยให้การเขียนเอกสารทางเทคนิค การเปิดประเด็นปัญหาที่อธิบายได้อย่างดี การแสดงความคิดเห็นที่ชัดเจนในคำขอรวมโค้ด และการเข้าร่วมการสนทนาใน Reddit มีประสิทธิภาพมากขึ้น ด้วยกฎสำคัญเพียงไม่กี่ข้อ เช่น หัวข้อ การเน้นข้อความ รายการ คำพูด บล็อกโค้ด ลิงก์ รูปภาพ และเทคนิคเฉพาะต่างๆ เช่น ตาราง รายละเอียดที่พับได้ การแจ้งเตือน เชิงอรรถ และสปอยล์ คุณสามารถเปลี่ยนจากการเขียนข้อความที่น่าเบื่อไปเป็นการสร้างเนื้อหาที่สะอาดตา อ่านง่าย และดูเป็นมืออาชีพได้โดยไม่ต้องคลิกเมาส์แม้แต่ครั้งเดียว
