Doküman düzeni

Doküman düzeni

Doküman düzeni, belgeler için iki sütunlu bir düzen — solda açıklama, sağda kod — mobilde tek sütuna daralan bir yapıdır.

Yapı

.doc dış sarmalayıcı olarak ve her satır için .doc-section kullanın. Her bölümde bir .doc-section--description ve bir .doc-section--code sütunu bulunur.

Temel bölüm

Tipik bir bölüm, bir açıklama bloğunu bir kod parçası ile eşleştirir.

Demo içeriği
<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>

Kod bloğu ile

.doc-section--code içerisinde sözdizimi vurgulamalı örnekler için code-block kısmını kullanın.

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