เอกสารDocumentationContributingAdding new docs

การเพิ่มเอกสารใหม่

เพิ่มเอกสารใหม่ลงในเว็บไซต์เอกสารและบล็อกของคุณ

สำหรับเอกสาร

  1. สร้างไฟล์ .mdx ใหม่ในโฟลเดอร์ apps/content/docs/[language] พร้อมเนื้อหาของเอกสารของคุณ
  2. เพิ่มเอกสารนั้นลงในเมนูนำทางของเว็บไซต์ เมื่อต้องการทำสิ่งนี้ ให้เพิ่มรายการใหม่ในไฟล์ src/config/docs.ts ภายในพร็อพเพอร์ตี sidebarNav พร้อมข้อมูลที่ต้องการ โดยทำตามรูปแบบของรายการที่มีอยู่ เมื่อทำเช่นนี้ เอกสารจะถูกเพิ่มลงใน command palette สำหรับการค้นหาด้วย

การตั้งค่าเอกสาร MDX

เอกสาร MDX ถูกเก็บไว้ในโฟลเดอร์ apps/content/docs/[language] และ apps/content/blog/[language] เอกสารแต่ละรายการเป็นไฟล์ MDX ที่มีส่วนหัวพร้อมเมตาดาต้า เช่น ชื่อเรื่องและคำอธิบาย ด้านล่างคือตัวอย่างส่วนหัวของเอกสาร:

---
title: Document Title
description: Document Description.
sort: 1
---

รองรับฟิลด์เมตาดาต้าต่อไปนี้:

  • title (จำเป็น): ชื่อเรื่องของเอกสาร
  • description (จำเป็น): คำอธิบายสั้นๆ ของเอกสาร
  • sort (ไม่บังคับ): ตัวเลขที่กำหนดลำดับของเอกสารในการนำทาง เอกสารที่มีค่า sort ต่ำกว่าจะแสดงก่อน หากไม่ได้ระบุ เอกสารจะถูกจัดเรียงตามตัวอักษรจากชื่อเรื่อง
  • links (ไม่บังคับ): ลิงก์ไปยังเอกสารที่เกี่ยวข้อง, API references, ซอร์สโค้ด ฯลฯ
  • toc (ไม่บังคับ): กำหนดว่าจะแสดงสารบัญหรือไม่ ค่าเริ่มต้นคือ true

หากต้องการเพิ่มเมตาดาต้าใหม่ลงในเอกสาร คุณสามารถเพิ่มคีย์ใหม่ในส่วนหัวได้ ตัวอย่างเช่น คุณสามารถเพิ่มคีย์ author เพื่อระบุผู้เขียนเอกสาร:

---
title: Document Title
description: Document Description.
sort: 2
author: Author Name
---

แต่เมื่อเพิ่มเมตาดาต้าแบบกำหนดเอง คุณต้องอัปเดตไฟล์ contentlayer.config.ts ที่อยู่ในรากของโปรเจกต์ และภายในพร็อพเพอร์ตี fields ในค่าคงที่ Doc หรือ Blog ด้วย หลังจากนั้น คุณจะต้องแสดงข้อมูลใหม่ในเทมเพลตเอกสาร เมื่อต้องการทำสิ่งนี้ คุณจะต้องอัปเดตไฟล์ src/app/[locale]/docs/[[...slug]]/page.tsx หรือ src/app/[locale]/blog/[[...slug]]/page.tsx หรือคอมโพเนนต์ลูกตัวใดตัวหนึ่งของไฟล์เหล่านั้น

การสร้าง Contentlayer ใหม่

เมื่อคุณเปลี่ยนแปลงเนื้อหาเอกสาร เพิ่มเอกสารใหม่ หรือแก้ไขไฟล์ contentlayer.config.ts คุณจะต้องสร้างแคช contentlayer ใหม่เพื่อให้การเปลี่ยนแปลงมีผลในระหว่างการพัฒนา ให้รัน:

cd apps/web
pnpm contentlayer:build

คำสั่งนี้จะสร้างชนิดข้อมูลและข้อมูลที่แอปพลิเคชันต้องใช้ขึ้นมาใหม่ คุณจะต้องรันคำสั่งนี้ทุกครั้งที่คุณ:

  • เพิ่มฟิลด์เมตาดาต้าใหม่ในไฟล์ contentlayer.config.ts
  • เพิ่มหรือแก้ไขเนื้อหา MDX เมื่อ dev server ไม่ได้ทำงานอยู่
  • เปลี่ยนโครงสร้างการจัดระเบียบเนื้อหาของคุณ

คำสั่งนี้จะถูกรันโดยอัตโนมัติเมื่อสร้างโปรเจกต์สำหรับ production แต่คุณจะต้องรันเองระหว่างการพัฒนา หากคุณทำการเปลี่ยนแปลงเชิงโครงสร้างกับเนื้อหา