docs.surrealdb.com
1.0.0
เอกสารสำหรับ Surrealdb สร้างขึ้นโดยใช้ Astro
หากคุณต้องการมีส่วนร่วมโปรดอ่านแนวทางที่มีส่วนร่วม
เยี่ยมชม Surrealdb.com/docs เพื่อเริ่มต้นกับ Sogrealdb
โปรดดูแนวทางการสนับสนุนของเรา
เรามีรายการปัญหาแรกที่ดีที่มีข้อบกพร่องที่มีขอบเขตค่อนข้าง จำกัด นี่เป็นสถานที่ที่ดีในการเริ่มต้นรับประสบการณ์และทำความคุ้นเคยกับกระบวนการบริจาคของเรา
ในการเริ่มต้นด้วยการมีส่วนร่วมในเอกสาร SONREALDB ก่อนอื่นให้ติดตั้งแพ็คเกจที่ต้องการโดยใช้คำสั่งต่อไปนี้
โครงการนี้ใช้ BUN เป็นผู้จัดการแพ็คเกจของเรา หากคุณยังไม่ได้ติดตั้ง BUN โปรดดูคู่มือการติดตั้งสำหรับระบบปฏิบัติการของคุณ นอกจากนี้ยังต้องใช้ node.js v20.0.0 หรือสูงกว่า
bun i คำสั่งต่อไปนี้เริ่มต้นเซิร์ฟเวอร์การพัฒนาท้องถิ่นและเปิดหน้าต่างเบราว์เซอร์ การเปลี่ยนแปลงส่วนใหญ่สะท้อนให้เห็นสดโดยไม่ต้องรีสตาร์ทเซิร์ฟเวอร์
bun dev
คำสั่งต่อไปนี้จะสร้างและสร้างเนื้อหาคงที่ลงในไดเรกทอรี build และจากนั้นสามารถให้บริการโดยใช้บริการโฮสต์เนื้อหาคงที่ใด ๆ
bun run build
เพื่อมีส่วนร่วมในเอกสารการเปลี่ยนแปลงส่วนใหญ่ของคุณจะทำกับไดเรกทอรี src/content แต่ละส่วนของเอกสารมีไดเรกทอรีย่อยของตัวเองและแต่ละหน้าเป็นไฟล์ MDX
src/
assets/
components/
content/
doc-surrealdb/
doc-surrealql/
doc-surrealist/
...
layouts/
pages/
styles/
util/ เพื่อให้แน่ใจว่าเอกสารนั้นสอดคล้องกันและเป็นไปตามคู่มือสไตล์ของเราเราใช้ make qc เพื่อตรวจสอบข้อผิดพลาดของผ้าสำลี คุณยังสามารถใช้ make qa เพื่อแก้ไขข้อผิดพลาดส่วนใหญ่โดยอัตโนมัติ
นี่คือคำสั่งสำหรับคำสั่งทั่วไปบางอย่างที่คุณอาจต้องใช้
make install - ติดตั้งการพึ่งพาครั้งแรกหรือเมื่อพวกเขาเปลี่ยนmake dev - เรียกใช้เซิร์ฟเวอร์การพัฒนาmake build - สร้างเว็บไซต์make preview - ดูตัวอย่างงานสร้างที่คุณทำmake qc - ตรวจสอบคุณภาพรหัส (fmt + lint)make qa - ใช้คำแนะนำคุณภาพรหัสที่ปลอดภัยmake qau - ใช้ (UN) คำแนะนำคุณภาพรหัสที่ปลอดภัย
