Documentindeling

De documentindeling is een tweekolomsindeling voor documentatiepagina's — beschrijving links, code rechts — die op mobiel samenvalt tot één kolom.

Structuur

Gebruik .doc als de buitenste wrapper en .doc-section voor elke rij. Elke sectie heeft een .doc-section--description en een .doc-section--code kolom.

Basissectie

Een typische sectie koppelt een beschrijvingsblok aan een codefragment.

Demoinhoud

<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>

Met een codeblok

Gebruik de code-block partial binnen .doc-section--code voor syntaxis-gehighlightte voorbeelden.

Demoinhoud

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