[How to] การเขียน Readme.md สำหรับการทำ Document ของ Software Open source

What is Readme.md ?

README เป็น text file ที่เอาไว้อธิบายรายละเอียดของ Project หรือ Information นั้นๆ ให้ทุกคนเข้าใจตรงกัน โดนจะเขียนอยู่ในรูปแบบ Format ของ Markdown language ยกตัวอย่าง

What is Markdown language ?

Markdown is lightweight markup language จะเป็นการใส่ format เข้าไปใน Text

Let get started with Markdown language

เดี๋ยวเราจะมาเริ่มวิธีการเขียน Markdown กันซึ่งก็จะเป็นสัญญาลักษณ์พื้นๆ ที่ถ้าอ่านจบก็สามารถนำไปทำ Document สวยๆ สำหรับระบบได้เลยครับ

Headers — ใช้ในการเขียนหัวข้อซึ่งหลักๆ จะมีอยู่ 6 ระดับไล่จาก 1–6 หรือใหญ่ไปเล็ก

Emphasis — สำหรับจัดการข้อความตัวเอียงและหนา

Lists — สำหรับการเขียนหัวข้อมีทั่งแบบตัวเลขและแบบวงกลมทั่วไป

Images — ไว้แสดงผลรูปภาพจากลิ้งข้างนอก

Links — ไว้แปะลิ้งเพื่อกดไปยังเว็บอื่นหรือเรียกว่า Hyper links

Block quotes — สำหรับใส่ข้อความในลักษณ์คำพูด

Black slash escapes — สำหรับแสดงสัญญาลักษณ์เช่น * หรืออื่นเพราะปกติแล้วมันถูกใช้ทำตัวหนาแต่ถ้าเราอยากจะแสดงผลเป็น * จริงๆ เราก็ทำได้แบบนี้

Tables — สำหรับสร้างตาราง

Codes — สำหรับแสดงผลหรือจัดฟอร์แมตโค้ด สำหรับอักษรตัวที่ใช้งานนั้นปุ่มจะอยู่ที่ตัวหนอน หรือตัวเปลี่ยนภาษาของ Windows และมันคนละแบบกับ Single quote

Checkbox — ไว้สำหรับทำตัวเลือกหรือติ๊กถูก

Have a question?

Drop us a line and we will get back to you