เห็นมีการแนะนำ Runme หรือ การ run ไฟล์ READE.md หรือ markdown format ได้
ช่วยทำให้การเขียนเอกสารมันมีความสามารถเพิ่มขึ้น
หรือเรียกได้ว่า มันเหมือน Jupyter notebook นั่นเอง
โดย Runme นั้นมีความสามารถพื้นฐานดังนี้
- เขียนในรูปแบบของไฟล์ Markdown ซึ่งน่าจะเป็นรูปแบบที่นักพัฒนาคุ้นเคย
- เขียนเอกสารได้ปกติ เพิ่มเติมคือ เพิ่มส่วนของ code ได้ ทำให้เราสามารถ run ได้ เหมือน command line นั่นเอง
ดังนั้นจึงสามารถนำมาประยุกต์ได้เยอะเลย
ยกตัวอย่างเช่น
- อธิบายการติดตั้งหรือ setup ระบบงาน สามารถอ่านไปทำไปได้เลย
- สามารถ integrate กับระบบ หรือ software ต่าง ๆ ได้เลย เช่น develop, test และ operation หรือไป DevOps ก็ว่ากันไป
การใช้งานก็ง่ายมาก ๆ
สามารถติดตั้งได้หลายรูปแบบ เช่น
- ติดตั้งผ่าน command line
- ติดตั้งผ่าน VS Code ได้เลย
- ติดตั้งเป็น self-host ผ่าน web browser
- มี Docker image ให้ด้วย
ตัวอย่าง เอามาเขียนอธิบายการพัฒนาระบบงานด้วย NodeJS
ช่วยทำให้สามารถอ่านไป และ run ได้เลย
ลองใช้งานกันดูนะครับ
