วิธีใช้งาน Markdown บน GitHub และ Reddit อย่างรวดเร็ว

อินฟอร์เมเทค ดิจิตอล » Recursos » วิธีใช้งาน Markdown บน GitHub และ Reddit อย่างรวดเร็ว

หากคุณเขียนโค้ดบน GitHub เป็นประจำ หรือใช้เวลาบน Reddit มาก การเรียนรู้ทักษะนี้ให้เชี่ยวชาญจะเป็นประโยชน์อย่างยิ่ง Markdown มันเป็นหนึ่งในสิ่งที่จะช่วยประหยัดเวลาและทำให้ชีวิตคุณง่ายขึ้น มันเป็นภาษามาร์กอัปที่มีน้ำหนักเบามาก ช่วยให้คุณจัดรูปแบบข้อความธรรมดาได้อย่างรวดเร็ว โดยไม่ต้องยุ่งยากกับการใช้เมนูหรือปุ่ม เพียงแค่ใช้สัญลักษณ์ไม่กี่ตัววางไว้ในตำแหน่งที่ถูกต้อง

บน GitHub คุณจะพบมันได้ทุกที่: ในไฟล์ต่างๆ README.md จากคลังเก็บข้อมูล ปัญหา คำขอรวมโค้ด การสนทนา และแม้แต่โปรไฟล์ของคุณเอง ส่วน Reddit นั้นใช้รูปแบบที่เรียกว่า Snoomark (Markdown สไตล์ Reddit) ซึ่งสืบทอดไวยากรณ์ส่วนใหญ่มาจาก GitHub พร้อมด้วยคุณสมบัติเฉพาะตัวและข้อจำกัดบางประการ มาดูกันทีละขั้นตอนพร้อมตัวอย่างมากมาย วิธีใช้งาน Markdown บน GitHub และ Reddit อย่างรวดเร็ว และโดยไม่ละเลยสิ่งสำคัญใดๆ

Markdown คืออะไร และทำไมจึงมีประโยชน์มากบน GitHub และ Reddit?

มาร์กดาวน์คือก ภาษาการมาร์กอัปน้ำหนักเบา ออกแบบมาเพื่อให้ข้อความธรรมดาอ่านและเขียนได้ง่าย พร้อมทั้งแปลงเป็น 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, เป็นต้น) เพื่อให้เป็นเอกลักษณ์

วิธีนี้ช่วยให้คุณทำสิ่งต่างๆ ได้ เช่น การวางส่วนต่างๆ ## ตัวอย่างส่วน จากนั้นให้สร้างลิงก์ไปยังหน้านั้นจากจุดอื่นในเอกสารโดยใช้ลิงก์ลักษณะนี้: (#ตัวอย่างส่วน)หรือแม้กระทั่งเชื่อมโยงไปยังส่วนต่างๆ ที่มีอักขระพิเศษในชื่อเรื่อง เนื่องจาก GitHub สร้างโค้ดตัวอย่างตามกฎเหล่านั้นและทำให้สามารถเข้าถึงได้โดยใช้รูปแบบเดียวกัน

การเน้นข้อความ, ข้อความที่ไฮไลต์ และคำพูดอ้างอิง

Markdown อนุญาตให้คุณเน้นข้อความโดยใช้วิธีการต่างๆ ความสำคัญตัวหนา ตัวเอียง ขีดฆ่า ตัวห้อย ตัวยก หรือขีดเส้นใต้ บน GitHub ตารางกำหนดรูปแบบทั่วไปจะมีลักษณะเช่นนี้ แม้ว่าเราจะสรุปไว้ในที่นี้ด้วยคำพูดที่แตกต่างกันก็ตาม:

เพื่อใส่ข้อความลงไป ตัวหนาข้อความตัวหนาจะอยู่ภายในเครื่องหมายดอกจันคู่หรือขีดเส้นใต้คู่ ส่วนข้อความตัวเอียงจะใช้เครื่องหมายดอกจันเดี่ยวหรือขีดเส้นใต้เดี่ยว และการขีดฆ่าข้อความจะใช้เครื่องหมายทิลเดคู่ (สองตัว) วางไว้ทั้งสองด้านของข้อความ นอกจากนี้ยังสามารถใช้ตัวหนาและตัวเอียงร่วมกันได้ โดยใช้เครื่องหมายดอกจันสามตัวเพื่อใช้ทั้งสองแบบกับข้อความทั้งหมด หรือสามารถใช้แท็ก HTML เช่น <br> ก็ได้ _{y ^{สำหรับตัวห้อยและตัวยก และ สำหรับการขีดเส้นใต้}}

GitHub ยังอนุญาตให้คุณสร้างสิ่งต่างๆ ได้อีกด้วย คำพูดแบบบล็อกอ็อบเจ็กต์ โดยการวางสัญลักษณ์มากกว่า (>) ไว้ที่ต้นบรรทัด ข้อความที่ยกมาจะแสดงด้วยแถบแนวตั้งทางด้านซ้ายและเป็นสีเทา ทำให้ข้อความโดดเด่นชัดเจน สามารถใส่ข้อความได้หลายบรรทัดในบล็อกข้อความที่ยกมาเดียวกัน และยังสามารถซ้อนข้อความที่ยกมาได้โดยการเพิ่มสัญลักษณ์ > อีกหลายตัวที่ต้นบรรทัด

รูปแบบการอ้างอิงขั้นสูงที่มีเฉพาะใน GitHub คือ... การแจ้งเตือนหรือการตักเตือนข้อความแจ้งเตือนเหล่านี้ใช้ไวยากรณ์ blockquote เดียวกัน แต่บรรทัดแรกจะมีเครื่องหมายพิเศษเพื่อระบุประเภทของข้อความแจ้งเตือน ตัวอย่างเช่น คุณสามารถระบุ `<alert>` สำหรับข้อมูลที่เป็นประโยชน์ `<helpful tips>` สำหรับคำแนะนำเชิงปฏิบัติ `<key data>` สำหรับข้อมูลสำคัญ `<urgent notices>` สำหรับคำเตือนเร่งด่วน และ `<alert>` สำหรับคำเตือนเกี่ยวกับความเสี่ยงหรือผลกระทบเชิงลบ GitHub จะแสดงแต่ละประเภทด้วยสีและไอคอนที่แตกต่างกัน ซึ่งช่วยเน้นข้อมูลสำคัญในเอกสาร

Reddit ก็รองรับการอ้างอิงแบบง่ายๆ ด้วยสัญลักษณ์ > เช่นกัน แม้ว่าจะขาดระบบแจ้งเตือนที่ครบครันเหมือน GitHub ก็ตาม แต่ถึงกระนั้น ก็ยังคงเป็นวิธีที่ใช้งานได้ดีมาก การตอบกลับผู้อื่นโดยการอ้างอิงส่วนหนึ่งของข้อความของพวกเขา โดยไม่ต้องกล่าวซ้ำทั้งหมด

การเน้นโค้ด, บล็อก และสี

ทั้ง GitHub และ Reddit อนุญาตให้คุณเน้นโค้ดที่อยู่ในข้อความโดยใช้เครื่องหมายแบ็กติ๊ก (`) สำหรับโค้ดที่แทรกอยู่ในข้อความ คุณจะต้องใส่เครื่องหมายแบ็กติ๊กหนึ่งตัวคร่อมคำหรือคำสั่งนั้นไว้ทั้งสองด้าน วิธีนี้เหมาะสำหรับการเน้นข้อความ เช่น a สถานะ git ภายในประโยคเดียว ทำให้ชัดเจนว่าเป็นคำสั่ง

เมื่อต้องการเขียนโค้ดเป็นส่วนๆ แยกต่างหาก Markdown จะใช้เครื่องหมายแบ็กติ๊กสามตัว: คุณเขียนบรรทัดด้วยเครื่องหมายแบ็กติ๊กสามตัว จากนั้นเขียนโค้ดในบรรทัดแยกกัน และปิดท้ายด้วยเครื่องหมายแบ็กติ๊กอีกสามตัว ใน GitHub หากคุณระบุภาษาไว้หลังเครื่องหมายแบ็กติ๊กตัวแรกด้วย ก็จะใช้ได้เช่นกัน... การเน้นไวยากรณ์ โดยใช้สีและรูปแบบเฉพาะสำหรับภาษานั้นๆ

GitHub ยังมีฟีเจอร์เฉพาะสำหรับการเน้นข้อความอีกด้วย ค่าสี ภายในเครื่องหมายแบ็กติ๊ก หากคุณเขียนสีในรูปแบบเลขฐานสิบหก RGB หรือ HSL ระหว่างเครื่องหมายแบ็กติ๊ก แพลตฟอร์มจะแสดงตัวบ่งชี้สีขนาดเล็กถัดจากข้อความ ตัวอย่างเช่น หากพื้นหลังในโหมดสว่างคือ #ffffff และในโหมดมืดคือ #000000 การไฮไลต์รหัสเหล่านี้จะช่วยให้คุณเห็นได้อย่างรวดเร็วว่าอันไหนเป็นอันไหน

ในส่วนของการแสดงโค้ดและตารางนั้น GitHub อนุญาตให้คุณเปิดใช้งานฟอนต์แบบ monospace คงที่ในช่องแสดงความคิดเห็นทั้งหมด เพื่อให้การทำงานกับข้อความทางเทคนิคสะดวกสบายยิ่งขึ้น หากคุณแก้ไขโค้ดจำนวนมากในเบราว์เซอร์หรือในโปรแกรมแก้ไขข้อความต่างๆ เช่น รหัส Visual Studioการเปิดใช้งานตัวเลือกนี้จะช่วยให้การจัดแนวและการอ่านง่ายขึ้น มีความสอดคล้องกันมากขึ้น.

นอกจากนี้ 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 ด้วย อุปกรณ์ชิ้นนี้มีประโยชน์อย่างยิ่งสำหรับการชาร์จ รูปภาพตอบสนอง ภาพเหล่านี้จะเปลี่ยนแปลงไปตามการตั้งค่าธีมของผู้ใช้ (สว่างหรือมืด) โดยใช้ media query `prefers-color-scheme` คุณสามารถกำหนดแหล่งที่มาของภาพที่แตกต่างกันสำหรับแต่ละโหมด และกำหนดภาพเริ่มต้นสำหรับเบราว์เซอร์ที่ไม่รองรับคุณสมบัตินี้ได้

รูปแบบทั่วไปเกี่ยวข้องกับการรวมไว้ภายใน องค์ประกอบหลายอย่าง พร้อมด้วยแอตทริบิวต์ media และ srcset และสุดท้ายคือ การใช้แอตทริบิวต์ alt และ URL ทั่วไป จะช่วยให้ผู้ใช้ในโหมดมืดเห็นภาพที่ปรับเปลี่ยน ในขณะที่ผู้ใช้ในโหมดสว่างจะได้รับภาพที่แตกต่างออกไป โดยไม่ต้องคัดลอกเนื้อหาในไฟล์ README ซ้ำซ้อน

GitHub ยังรองรับการใส่ความคิดเห็นในรูปแบบ HTML ในไฟล์ Markdown ซึ่งช่วยให้คุณสามารถเพิ่มข้อความเตือนที่มองไม่เห็นให้กับผู้อ่านได้ เช่น เพื่อเตือนให้พวกเขาอัปเดตส่วนรูปภาพหรือเพิ่มตัวอย่างใหม่ในภายหลัง

ตาราง ส่วนที่พับได้ และการแบ่งเนื้อหา

หนึ่งในคุณสมบัติที่มีประโยชน์ที่สุดของ GitHub Flavored Markdown คือการรองรับ วาดคุณสามารถจัดระเบียบข้อมูลเป็นแถวและคอลัมน์โดยใช้เส้นแนวตั้งเพื่อแยกเซลล์และเส้นประเพื่อทำเครื่องหมายส่วนหัว นอกจากนี้ คุณยังสามารถจัดแนวคอลัมน์ไปทางขวา ซ้าย หรือตรงกลางโดยใช้เครื่องหมายโคลอนในแถวคั่นได้

ตารางมีประโยชน์มากสำหรับการนำเสนอรายการภาษาโปรแกรม เฟรมเวิร์กที่ใช้ งานที่วางแผนไว้ การเปรียบเทียบคุณสมบัติ หรือข้อมูลอื่น ๆ ที่ได้รับประโยชน์จากโครงสร้างแบบเมทริกซ์ GitHub แสดงผลตารางเหล่านี้ด้วยรูปแบบที่สะอาดตาและอ่านง่าย

หากต้องการจัดระเบียบไฟล์ README ที่ยาว คุณสามารถใช้แท็ก HTML ได้ เพื่อสร้างส่วนที่สามารถพับได้ ส่วนเหล่านี้จะแสดงข้อมูลสรุปภายในป้ายกำกับ และอนุญาตให้ผู้ใช้ขยายหรือย่อขนาดได้ เนื้อหาเพิ่มเติม ตามความจำเป็น โดยทั่วไปมักจะใส่ตารางหรือข้อมูลเพิ่มเติมไว้ภายใน เพื่อไม่ให้ดวงตาได้รับความเพลิดเพลินมากเกินไป

หากคุณต้องการให้ส่วนนั้นแสดงผลแบบขยายโดยค่าเริ่มต้น เพียงแค่เพิ่มแอตทริบิวต์ open เข้าไป เทคนิคนี้มีประโยชน์มากสำหรับการจัดกลุ่มการจัดอันดับ รายการยาวๆ หรือเนื้อหาที่ไม่จำเป็นสำหรับการอ่านครั้งแรก แต่สะดวกที่จะเข้าถึงได้ง่าย

อีกหนึ่งเครื่องมือที่ง่ายสำหรับการจัดระเบียบข้อมูลคือเส้นแบ่งแนวนอน ซึ่งสร้างขึ้นโดยการเขียนขีดสามขีดขึ้นไปบนเส้นเดียว และใช้เพื่อแบ่งส่วนต่างๆ ออกจากกัน ทำให้คุณสามารถแยกส่วนต่างๆ ได้อย่างชัดเจน เช่น ส่วนคำอธิบายออกจากส่วนอ้างอิงหรือหมายเหตุเพิ่มเติม

กฎเหล่านี้สามารถนำไปใช้ร่วมกับคำคมท้ายเอกสารเพื่อเน้นวลีสร้างแรงบันดาลใจ ข้อเตือนใจ หรือข้อความสำคัญได้ ตัวอย่างทั่วไปคือการวางคำคมสร้างแรงบันดาลใจไว้ท้ายไฟล์ README ของโปรไฟล์ของคุณ โดยจัดรูปแบบเป็นข้อความอ้างอิงแบบบล็อกหลังจากเส้นคั่น

ซ่อนความคิดเห็นและการควบคุมรูปแบบ

GitHub อนุญาตให้คุณแนะนำ ความคิดเห็น HTML ภายใน Markdown โดยใช้ไวยากรณ์ ข้อความใดๆ ที่คุณใส่ไว้ในช่องแสดงความคิดเห็นนั้น จะไม่แสดงในเนื้อหาที่แสดงผล แต่จะมองเห็นได้ในซอร์สโค้ด ดังนั้นจึงเหมาะสำหรับบันทึกภายในหรือรายการสิ่งที่ต้องทำ

ตัวอย่างเช่น ในไฟล์ README ของโปรไฟล์ คุณสามารถเพิ่มความคิดเห็นที่ระบุว่าคุณจำเป็นต้องขยายส่วน "เกี่ยวกับฉัน" ในภายหลัง หรือคุณจำเป็นต้องตรวจสอบตารางเทคโนโลยีที่ล้าสมัย โดยที่ผู้ที่เข้าชมโปรไฟล์จะไม่เห็นความคิดเห็นนั้นโดยตรง

ฟังก์ชั่นที่มีประโยชน์อีกอย่างหนึ่งก็คือ ตัวละครหลบหนี ซึ่งโดยปกติจะถูกตีความว่าเป็น Markdown หากคุณต้องการแสดงเครื่องหมายดอกจัน เครื่องหมายแฮช หรือสัญลักษณ์อื่นๆ โดยไม่จัดรูปแบบ ให้ใส่เครื่องหมายแบ็กสแลชนำหน้าแต่ละสัญลักษณ์ วิธีนี้ช่วยให้คุณสามารถเขียนนิพจน์ที่มีสัญลักษณ์รายการได้โดยไม่ต้องแปลงเป็นรายการจริง

เมื่อคุณดูไฟล์มาร์กอัปบน GitHub คุณจะมีตัวเลือกในการสลับระหว่างมุมมองที่แสดงผลและซอร์สโค้ดด้วยปุ่มที่ด้านบน (หรือเปิดในโปรแกรมแก้ไขข้อความต่างๆ เช่น...) วงเล็บการปิดใช้งานการตีความ Markdown จะช่วยให้คุณเข้าถึงคุณสมบัติการแสดงโค้ดทั่วไปได้ เช่น เชื่อมโยงเส้นเฉพาะฟังก์ชันนี้มีประโยชน์มากเมื่อคุณต้องการชี้ไปยังส่วนใดส่วนหนึ่งโดยเฉพาะในไฟล์ README หรือไฟล์ .md ใดๆ

สุดท้ายนี้ โปรดจำไว้ว่า GitHub จัดการกับการขึ้นบรรทัดใหม่แตกต่างกันในความคิดเห็น (ปัญหา, คำขอรวมโค้ด ฯลฯ) และในไฟล์ Markdown ในความคิดเห็น ระบบจะเคารพการขึ้นบรรทัดใหม่โดยตรง ในขณะที่ในไฟล์ Markdown คุณต้องเพิ่มช่องว่างสองช่องที่ท้ายบรรทัด เครื่องหมายแบ็กสแลช หรือจุด เพื่อบังคับให้เกิดการข้ามไปยังส่วนอื่นภายในย่อหน้าเดียวกัน

รายการ, รายการย่อย และรายการสิ่งที่ต้องทำ

รายการเป็นหนึ่งในองค์ประกอบที่ใช้บ่อยที่สุดใน Markdown ทั้งบน GitHub และ Reddit คุณสามารถสร้างรายการได้ ไม่เรียงลำดับ โดยการใส่เครื่องหมายขีดกลาง เครื่องหมายดอกจัน หรือเครื่องหมายบวกไว้หน้าแต่ละรายการ เครื่องหมายเหล่านี้จะแสดงผลคล้ายกับจุดนำหน้า

เพื่อสร้างรายการ สั่งซื้อแต่ละบรรทัดจะมีหมายเลขกำกับ โดยตามด้วยจุดและเว้นวรรค ลำดับของหมายเลขไม่จำเป็นต้องสมบูรณ์แบบ (โดยปกติ GitHub จะคำนวณใหม่ให้) แต่การรักษาลำดับหมายเลขให้สม่ำเสมอจะช่วยให้โค้ดอ่านง่ายขึ้น

สร้างรายการแบบซ้อนกันได้ง่ายๆ โดยการเพิ่มการเยื้องให้กับรายการด้านล่าง ในโปรแกรมแก้ไขข้อความแบบตัวอักษรคงที่ เช่น ข้อความประเสริฐเพียงแค่จัดตำแหน่งเครื่องหมายของรายการย่อยให้อยู่ด้านล่างอักขระตัวแรกของข้อความในองค์ประกอบหลัก ในบริบทเช่นโปรแกรมแก้ไขความคิดเห็นของ GitHub ที่แบบอักษรไม่ใช่แบบคงที่ ให้ลองนับจำนวนอักขระก่อนหน้าข้อความและใช้จำนวนช่องว่างนั้นสำหรับการเยื้อง

คุณสามารถสร้างโครงสร้างการซ้อนกันหลายระดับได้ ตราบใดที่จำนวนช่องว่างยังคงสม่ำเสมอ สำหรับรายการที่ซับซ้อนมาก ระบบนี้อาจต้องอาศัยการฝึกฝนเล็กน้อย แต่เมื่อคุณเข้าใจแล้ว ก็จะสามารถนำไปใช้ได้อย่างรวดเร็ว

GitHub ยังมีบริการอื่นๆ อีกด้วย รายการสิ่งที่ต้องทำรายการเหล่านี้มีประโยชน์มากสำหรับปัญหา คำขอแก้ไข และเอกสารต่างๆ สร้างได้โดยการนำเครื่องหมายขีดกลาง เว้นวรรค และวงเล็บเหลี่ยมสองอันมาไว้ข้างหน้า โดยมีเว้นวรรคหรือเครื่องหมาย "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 ยังรองรับอีกด้วย เชิงอรรถ โดยใช้ไวยากรณ์แบบวงเล็บและตัวระบุที่มีอักขระแทรก ในจุดที่คุณต้องการอ้างอิง คุณแทรกบางอย่างเช่น <a href="..."></a> และในตอนท้ายของเอกสาร คุณกำหนดข้อความของหมายเหตุนั้นด้วยแท็กเดียวกัน ตามด้วยเครื่องหมายโคลอนและเนื้อหา

เชิงอรรถสามารถครอบคลุมได้หลายบรรทัด และเพื่อให้เกิดการขึ้นบรรทัดใหม่ภายในเชิงอรรถ จะใช้การเว้นวรรคสองครั้งที่ท้ายบรรทัด เช่นเดียวกับในเนื้อหาหลักของ Markdown เมื่อแสดงผล GitHub จะแสดงตัวยกบนข้อความและรายการเชิงอรรถที่ท้ายสุด พร้อมลิงก์ย้อนกลับเพื่อนำทางระหว่างเอกสารอ้างอิงและเชิงอรรถ

อีกหนึ่งฟีเจอร์ขั้นสูงที่ GitHub นำเสนอคือ... การแจ้งเตือน หัวข้อเหล่านี้ได้มีการกล่าวถึงไปแล้ว (หมายเหตุ, เคล็ดลับ, สำคัญ, คำเตือน และ ข้อควรระวัง) ขอแนะนำให้ใช้เฉพาะเมื่อจำเป็นจริงๆ และหลีกเลี่ยงการใช้หลายๆ หัวข้อติดกันเพื่อป้องกันไม่ให้ผู้อ่านรู้สึกสับสน ไม่สามารถซ้อนหัวข้อเหล่านี้ไว้ในองค์ประกอบที่ซับซ้อนอื่นๆ ได้ ดังนั้นการวางแผนการจัดวางอย่างรอบคอบจึงเป็นสิ่งสำคัญ

สุดท้ายนี้ คุณสามารถขอให้ GitHub ซ่อนส่วนต่างๆ ของ Markdown ที่แสดงผลชั่วคราวได้โดยการครอบด้วยความคิดเห็น HTML หรือละเว้นการประมวลผลอักขระบางตัวด้วยเครื่องหมายแบ็กสแลช ซึ่งมีประโยชน์อย่างยิ่งเมื่อคุณกำลังจัดทำเอกสาร ไวยากรณ์เฉพาะของ Markdown และคุณต้องแสดงตัวอย่างตามความเป็นจริง โดยไม่มีการตีความใดๆ

Markdown บน Reddit: Snoomark และโหมดการแก้ไข

Reddit เป็นแพลตฟอร์มสนทนาที่เปิดรับแทบทุกหัวข้อ โดยจัดระเบียบเป็นซับเรดดิต ในแง่ของการจัดรูปแบบ มีตัวแก้ไขสองแบบ: แบบหนึ่งสำหรับข้อความที่มีรูปแบบสวยงาม และอีกแบบสำหรับข้อความธรรมดาโดยใช้ Markdown หากคุณต้องการทำงานอย่างรวดเร็วและควบคุมผลลัพธ์ได้อย่างละเอียด คุณควรใช้ตัวเลือก Markdown

โดยปกติแล้ว Reddit จะเปิดใช้งานโหมดแก้ไขข้อความแบบ Rich Text Editor ดังนั้นหากต้องการเปลี่ยนไปใช้โหมดมาร์กอัป คุณต้องคลิกที่ตัวเลือกนั้น โหมดมาร์คดาวน์ ภายในช่องข้อความของโพสต์หรือความคิดเห็น จากนั้นคุณสามารถใช้ไวยากรณ์ Snoomark ได้โดยตรง

หากคุณต้องการให้โปรแกรมแก้ไข Markdown โหลดขึ้นมาทุกครั้ง ให้ไปที่การตั้งค่าผู้ใช้ เข้าสู่ส่วนการตั้งค่าฟีด และเปิดใช้งานตัวเลือกนั้น ค่าเริ่มต้นคือ Markdownด้วยวิธีนี้ ทุกครั้งที่คุณเริ่มเขียนโพสต์หรือความคิดเห็น โปรแกรมแก้ไข Markdown จะเปิดขึ้นโดยอัตโนมัติโดยที่คุณไม่ต้องเปลี่ยนข้อความด้วยตนเอง

Reddit รองรับฟีเจอร์ Markdown ขั้นพื้นฐานและขั้นสูงส่วนใหญ่ เช่น หัวข้อ ตัวหนาและตัวเอียง รายการ คำพูดอ้างอิง บล็อกโค้ด ลิงก์ และฟีเจอร์พิเศษบางอย่าง เช่น สปอยล์ อย่างไรก็ตาม Reddit มีข้อจำกัดที่สำคัญเมื่อเทียบกับ 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 จะช่วยให้การเขียนเอกสารทางเทคนิค การเปิดประเด็นปัญหาที่อธิบายได้อย่างดี การแสดงความคิดเห็นที่ชัดเจนใน Pull Request และการเข้าร่วมการสนทนาใน Reddit มีประสิทธิภาพมากขึ้น ด้วยกฎสำคัญเพียงไม่กี่ข้อ เช่น หัวข้อ การเน้นข้อความ รายการ คำพูด บล็อกโค้ด ลิงก์ รูปภาพ และเทคนิคเฉพาะต่างๆ เช่น ตาราง รายละเอียดที่พับได้ การแจ้งเตือน เชิงอรรถ และสปอยเลอร์ คุณสามารถเปลี่ยนจากการเขียนข้อความธรรมดาไปเป็นการสร้างเอกสารที่มีประสิทธิภาพได้ เนื้อหาสะอาด อ่านง่าย และเป็นมืออาชีพ โดยไม่ต้องแตะปุ่มเมาส์แม้แต่ปุ่มเดียว