ข้อตกลงการเขียนโค้ด
ทำตามข้อตกลงเหล่านี้เพื่อให้หน้าเว็บทั้งหมดมีรูปแบบสอดคล้องกัน
โครงสร้างหน้า
ทุกหน้าต้องมี frontmatter และหัวข้อระดับบนสุดเพียงหัวข้อเดียว
Frontmatter
ใส่ title และ description ใน frontmatter ของทุกหน้า
markdown
---
title: Page Title
description: One sentence describing the page.
---
# Page Titleหัวข้อ (Headings)
ใช้ # เพียงหัวข้อเดียวต่อหน้า ใช้ ## สำหรับหัวข้อย่อย และ ### สำหรับหัวข้อย่อยระดับถัดไป sidebar ด้านขวาสร้าง outline จากหัวข้อเหล่านี้ ตั้งชื่อให้สื่อความหมาย
องค์ประกอบการจัดรูปแบบ
ตารางด้านล่างแสดงองค์ประกอบ Markdown ที่ใช้ในหน้าตัวอย่างของเว็บไซต์นี้
| องค์ประกอบ | Syntax | วัตถุประสงค์ |
|---|---|---|
| ตาราง | | a | b | | เปรียบเทียบค่าที่มีโครงสร้าง |
| Code block | ```lang | แสดงคำสั่งหรือ config ที่แน่นอน |
| Container | ::: tip / ::: warning | เน้นข้อความสำคัญ |
TIP
ใช้ตารางแทน bullet list เมื่อคุณเปรียบเทียบมากกว่าหนึ่งคุณสมบัติต่อรายการ
WARNING
ห้ามใส่ secrets, token หรือรหัสผ่านในหน้า Markdown ใดๆ — repository นี้ถูก version-control และ อ่านได้โดยทุกบัญชีที่มีสิทธิ์เข้าถึงเอกสาร
การลิงก์ระหว่างหน้า
ลิงก์ด้วย root-relative path พร้อมนามสกุล .md เช่น เริ่มต้นใช้งาน ดู หมายเหตุการจัดการรูปภาพ สำหรับวิธีอ้างอิงรูปภาพ
