README.md อ่านฉันทีมีอะไรจะบอก !?!

Max Veerapat Kumchom
2 min readOct 28, 2017

สวัสดีครับผมแมกซ์นะครับ ช่วงนี้ฝนไม่ค่อยตกเลยเนอะบทความนี้จะเป็นการเล่าถึงความสามารถ การใช้งานไฟล์ รวมถึงเครื่องมือในการสร้างไฟล์ เชิญรับชมรับฟังได้เลยครับ :D

README.md คือ ไฟล์ประเภท Markdown แล้วไอ้นี่คืออะไร ? Markdown คือไฟล์ที่มีนามสกุลเป็น .md หรือ .markdown มีรูปแบบเป็นไฟล์ Text ธรรมดาๆ ที่มีความสามารถในการกำหนดรูปแบบ การแสดงผลข้อความ เช่น การทำ ตัวหนา ตัวเอียง แสดงรูปภาพ การสร้างตาราง รวมไปถึงการสร้างลิ้งเชื่อมโยงไปยังเว็บต่างๆ และอื่นๆอีกมากมาย เพียงแค่การกำหนดแท็กง่ายๆ ยกตัวอย่าง **bold** , *italic* , [link to Google!](http://google.com)

มีประโยชน์อย่างไร ความสามารถในการแสดงผลข้อความในรูปแบบต่างๆได้ตามที่เรากำหนด เขียนได้ง่าย อ่านง่าย มีขนาดเล็ก เข้าถึงได้ง่าย สบายตา และถูกนำไปใช้งานในแง่ของการสร้าง Documentation ซึ่งแน่นอนว่า Library แทบทุกตัวบน Github มีไฟล์นี้และทุก Repo ที่ถูกสร้างขึ้น จะแนะนำให้สร้างไฟล์ชื่อว่า “README.md” ใช้แสดงรายอะเอียดในหน้าแรกของ Repo นั้นๆ

ความสามารถ งานเกี่ยวกับเอกสารต่างๆ จะให้ดีต้องมีความสามารถในการแสดงผลในหลายๆรูปแบบ เพื่อตอบสนองการแสดงผลข้อมูลประเภทต่างๆที่เหมาะสม โดยความสามารถของมันก็มีดังนี้ Headers, Emphasis, Lists, Links, Images, Code and Syntax Highlighting, Tables, Blockquotes, Inline HTML, Horizontal Rule, Line Breaks, YouTube Videos ซึ่งขอหยิบตัวอย่างเด็ดๆอย่าง การสร้างตาราง

| Tables        | Are           | Cool   |
| ------------- |:-------------:| -----: |
| col 3 is | right-aligned | 53231฿ |
| col 2 is | centered | 399฿ |
| zebra stripes | are neat | 33฿ |

เพียงแค่เขียนรูปแบบการสร้างตารางที่กำหนดก็ได้ตารางอย่างที่เห็น และยังมีความสามารถอีกมากมายสามารถติดตามได้ที่

แค่นี้ยังง่ายไม่พอ แบบนี้จะง่ายได้ยังไง Microsoft Word ก็ทำได้คล่องกว่าเร็วกว่าด้วยผมจึงมานำเสนอ Tool สำหรับการสร้างไฟล์ Markdown

จะเห็นได้ว่าเครื่องมือในการสร้างไฟล์ Markdown เหล่านี้คล้ายๆ Microsoft Word หรือโปรแกรมสร้างไฟล์เอกสารที่เราคุ้นเคย รวมถึงการแสดง ส่วนการแก้ไข และ แบบการแสดงผลให้เราเห็นควบคู่ไปด้วย ทำให้เราสามารถจัดรูปแบบได้อย่างง่ายไปเลย ทั้งหมดนี้ออนไลน์สามารถปรับแก้ไขจากที่ไหนก็ได้ นอกจากนี้ยังมีความสามารถในการ Export ไฟล์ไปยังไฟล์รูปแบบอื่นอย่าง PDF

ได้ .md แล้วเปิดยังไง สำหรับการเปิดไฟล์ Markdown นั้นจะต้องเปิดผ่านโปรแกรมที่รองรับ Markdown Preview ซึ่งถ้าใช้ VSCode อยู่ละก็สามารถเปิดได้เลย แล้วถ้าไม่มีหล่ะ Chrome ก็สามารถติดตั้งส่วนเสริมเพื่ออ่านได้ แถมเลือก Theme ได้ด้วย

สุดท้ายแล้ว…แชร์ประสบการณ์การนำไปใช้ สิ่งที่ผมมาสนใจและใช้งานไฟล์ประเภทนี้เพราะปกติแล้ว ผมใช้ไฟล์ .txt ซึ่งสร้างโดย Notepad นี้แหละ ในการบันทึกโน๊ตที่ใช้ในการทำงาน เช่น ขั้นตอนการทำอะไรบ้างอย่างบนเซิฟเวอร์ การ Build ไฟล์ สคริปท์การ Run คำสั่งต่างๆ ซึ่งมันเยอะ และ จำไม่ได้สักที แล้ววันนึงมันเริ่มเยอะขึ้นและไฟล์ .txt หลายๆไฟล์ของผมมันเริ่มยาว และลายตาเพราะมันไม่มีการทำ ตัวหนา หัวข้อใหญ่ หัวข้อย่อย งงไปหมด ทำย่อหน้าก็แล้วยัง อ่านยากอยู่ดี ไฟล์ .md เป็นตัวช่วยที่ดีเลย แถมไฟล์ก็เล็กๆ เหมือน .txt ไฟล์ของเก่าแต่ความสามารถเหนือกว่าสุดๆ

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

--

--