writing-docs

โดย remotion-dev

แนวทางและเทมเพลตสำหรับการเขียนเอกสาร API ของ Remotion ในรูปแบบ MDX สร้างไฟล์ .mdx หนึ่งไฟล์ต่อหนึ่ง API ใน packages/docs/docs เพิ่มลงใน sidebars.ts และรัน bun render-cards.ts เพื่อสร้างการ์ดตัวอย่างโซเชียล ใช้หัวข้อ ### สำหรับคุณสมบัติของ API (ไม่ใช้สัญลักษณ์หัวข้อย่อย) เพิ่มคำต่อท้าย ? สำหรับพารามิเตอร์ที่ไม่บังคับ และรวมค่าเริ่มต้นในคำอธิบายอย่างเป็นธรรมชาติ เลือกใช้ตัวอย่างโค้ดที่ปลอดภัยต่อชนิดข้อมูลด้วยการตรวจสอบ twoslash ใช้ // ---cut--- เพื่อซ่อนการนำเข้า และเพิ่มแอตทริบิวต์ title เสมอใน...