เริ่มต้นอย่างรวดเร็ว
หน้านี้อธิบายวิธีอ่านเอกสารชุดนี้ และวิธีที่ผู้ดูแลอัปเดตเนื้อหา
สำหรับผู้อ่าน
เนื้อหาแบ่งเป็นสองประเภท
| ประเภท | เนื้อหา | ทางเข้า |
|---|---|---|
| คู่มือ | แนวคิด ขั้นตอนเริ่มต้นใช้งาน แนวปฏิบัติที่ดี | คู่มือ |
| เอกสารผลิตภัณฑ์ | ฟังก์ชัน พารามิเตอร์ และคำถามที่พบบ่อยของแต่ละผลิตภัณฑ์ | เอกสารผลิตภัณฑ์ |
แถบด้านบนมีช่องค้นหาทั้งเว็บไซต์ และปุ่มสลับภาษา 中文 / English / ไทย
สำหรับผู้ดูแล
เนื้อหาทั้งหมดคือไฟล์ Markdown ในคลังโค้ด ไม่มีระบบหลังบ้านแยกต่างหาก มีสามวิธีในการอัปเดต
bash
git clone https://github.com/FridaF-SI/WAND-docs.git
cd moonheart-docs
npm install
npm run docs:dev # ดูตัวอย่างสดที่ http://localhost:5173bash
git add docs/
git commit -m "docs: อัปเดตฟังก์ชันผลิตภัณฑ์ A"
git push # EdgeOne Pages จะสร้างและเผยแพร่ให้อัตโนมัติวิธีที่สามคือแก้ไขไฟล์ .md บนหน้าเว็บ GitHub โดยตรง เมื่อบันทึกแล้วจะกระตุ้นการเผยแพร่อัตโนมัติเช่นเดียวกัน
การเพิ่มหน้าใหม่
- สร้างไฟล์
your-product.mdในโฟลเดอร์docs/th/products/ - เริ่มไฟล์ด้วย front-matter
markdown
---
title: ชื่อผลิตภัณฑ์ของคุณ
description: คำอธิบายหนึ่งประโยค ใช้สำหรับผลการค้นหาและ SEO
---
# ชื่อผลิตภัณฑ์ของคุณ- ลงทะเบียนในส่วน
sidebarของไฟล์docs/.vitepress/config.mts - commit แล้ว push
เกี่ยวกับหลายภาษา
ภาษาจีนอยู่ใน docs/ ภาษาอังกฤษอยู่ใน docs/en/ ภาษาไทยอยู่ใน docs/th/ และทั้งสามใช้โครงสร้างเส้นทางเดียวกัน ไฟล์ docs/products/product-a.md จะมีฉบับภาษาไทยคือ docs/th/products/product-a.md กระบวนการแปลอัตโนมัติอาศัยข้อตกลงนี้
ขั้นตอนถัดไป
- อ่านแนวคิดหลัก เพื่อเข้าใจการจัดระเบียบเอกสาร
- ดูภาพรวมเอกสารผลิตภัณฑ์