Bố cục tài liệu

Bố cục tài liệu

Bố cục tài liệu là một mẫu hai cột cho các trang tài liệu — mô tả bên trái, mã bên phải — sẽ thu gọn thành một cột trên di động.

Cấu trúc

Sử dụng .doc làm bao ngoài và .doc-section cho mỗi hàng. Mỗi phần có một cột .doc-section--description và một cột .doc-section--code.

Phần cơ bản

Một phần điển hình kết hợp một khối mô tả với một đoạn mã.

Nội dung demo
<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>

Với một khối mã

Sử dụng phần code-block bên trong .doc-section--code cho các ví dụ được làm nổi bật cú pháp.

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