รูปแบบเอกสาร

รูปแบบเอกสารเป็นแบบอย่างสองคอลัมน์สำหรับหน้าสารบัญ — คำอธิบายอยู่ทางซ้าย โค้ดอยู่ทางขวา — ที่จะยุบเป็นคอลัมน์เดียวบนมือถือ.

โครงสร้าง

ใช้ .doc เป็น wrapper ภายนอกและ .doc-section สำหรับแต่ละแถว ทุกส่วนมี .doc-section--description และ .doc-section--code คอลัมน์.

ส่วนพื้นฐาน

ส่วนทั่วไปจะจับคู่บล็อคคำอธิบายกับโค้ดสั้น ๆ.

เนื้อหาตัวอย่าง

<div class="doc">
  <div class="doc-section">
    <div class="doc-section--description">
      <h3>Title</h3>
      <p>Description</p>
    </div>
    <div class="doc-section--code">
      <!-- code snippet -->
    </div>
  </div>
</div>

พร้อมบล็อคโค้ด

ใช้ส่วนโค้ดบล็อคภายใน .doc-section--code สำหรับตัวอย่างที่มีการเน้นไวยากรณ์.

เนื้อหาตัวอย่าง

{{ include('@Bundle/partials/code-block.html.twig', {
  lang: 'bash',
  code: 'curl https://api.example.com/resource'
}) }}