คู่มือในไฟล์ Markdown มี # หรือ * แต่พอแปลงเป็น Word กลายเป็นหัวข้อหรือรายการ ก่อนแก้ให้ดูว่าเครื่องหมายนั้นตั้งใจใช้ จัดรูปแบบ หรือเป็น ข้อความที่ต้องแสดงตรงตัว ทั้งสองอย่างต้องเขียนต่างกัน
ใช้ส่วนข้อความตรงตัวเมื่อสัญลักษณ์เป็นเนื้อหา
Pandoc อธิบายว่า code block เก็บช่องว่างและบรรทัด โดยไม่ให้สัญลักษณ์ภายในกระตุ้นการจัดรูปแบบ Markdown จึงเหมาะกับตัวอย่างคำสั่ง การตั้งค่า หรือข้อความที่ต้องตรวจทีละตัวอักษร
ตัวอย่างด้านล่างเป็น Markdown ต้นฉบับที่ใช้เครื่องหมายตัวหนอนสามตัวเปิดและปิดบล็อก พร้อมบรรทัดว่างก่อนและหลัง:
~~~
# sample heading text
* sample marker
~~~
ผลที่ต้องการคือให้สองบรรทัดด้านในแสดงเครื่องหมายด้วย ไม่กลายเป็นหัวข้อหรือรายการ ส่วนเครื่องหมายเปิดและปิดบล็อกเป็นไวยากรณ์ จึงไม่ใช่ข้อความที่จะปรากฏใน DOCX
เลือกใช้ให้ถูกส่วน
| เนื้อหา | แนวทางที่เราแนะนำ |
|---|---|
| หัวข้อจริงของคู่มือ | ใช้หัวข้อ Markdown ตามปกติ |
| ตัวอย่างที่ต้องเก็บ # และ * | ใช้ code block |
| ย่อหน้าคำอธิบายทั่วไป | วางนอก code block |
| โค้ดที่มีแถวเครื่องหมายปิดบล็อกอยู่แล้ว | ใช้รั้วเปิดและปิดที่ยาวกว่าด้านใน |
อย่าครอบทั้งเอกสารด้วย code block เพียงเพื่อรักษาเครื่องหมายไม่กี่จุด เพราะส่วนที่ควรเป็นหัวข้อและรายการจะกลายเป็นข้อความตัวอย่างไปด้วย
ตรวจผลหลังแปลง
- เก็บ Markdown ต้นฉบับไว้ แล้วเปิด Markdown เป็น Word
- เลือกไฟล์และแปลงเป็น DOCX
- เปิด Word เทียบเครื่องหมาย ช่องว่าง และบรรทัดของตัวอย่าง
- ตรวจย่อหน้าถัดจากบล็อกว่าไม่เผลออยู่ในบล็อกเพราะลืมปิด
- ถ้าต้องนำคำสั่งไปใช้ ให้ตรวจข้อความที่คัดลอกออกมาเทียบต้นฉบับอีกครั้ง
FileMyLove ใช้ตัวอ่าน Markdown ของ Pandoc และเขียนเป็น DOCX การแปลงไม่ได้รันคำสั่งตัวอย่าง และไม่รับประกันฟอนต์หรือสีไฮไลต์เหมือนตัวแก้ไข Markdown ทุกตัว
เก็บไฟล์ต้นฉบับสำหรับงานต่อ
DOCX เหมาะกับการส่งคู่มือให้อ่านหรือแก้ไข แต่ถ้าต้องใช้โค้ดจริง เราแนะนำให้เก็บไฟล์โค้ดหรือข้อความต้นฉบับแยกไว้ด้วย ดู คู่มือหัวข้อและรายการ Markdown สำหรับโครงสร้างเอกสาร และ การตรวจตาราง เมื่อมีข้อมูลหลายคอลัมน์
