מבנה מסמך
מבנה מסמך
מבנה המסמך הוא תבנית של שני טורים לדפי תיעוד — תיאור בצד שמאל, קוד בצד ימין — שמתמזגת לטור אחד במובייל.
מבנה
השתמש ב-.doc כעטיפה החיצונית וב-.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>
עם בלוק קוד
השתמש בחלק code-block בתוך .doc-section--code לדוגמאות עם הדגשת תחביר.
תוכן לדוגמה
{{ include('@Bundle/partials/code-block.html.twig', {
lang: 'bash',
code: 'curl https://api.example.com/resource'
}) }}