Дока — это справочный материал, кратко и формально описывающий некое понятие, например, свойство или тег. Как спецификация, только по-русски и понятным языком.
Мы помечаем доку тегом doka в шапке.
Структура доки примерно такова:
Код шапки
---
title: "Название доки"
description: "Описание для соцсетей, 160-200 символов"
cover:
author: nick_name
desktop: 'images/desktop.png'
mobile: 'images/mobile.png'
alt: 'Альтернативное описание для обложки'
authors:
- Никнейм основного автора
contributors:
- Никнеймы всех соавторов и контрибьюторов
editors:
- Никнеймы всех редакторов
keywords:
- Альтернативные теги для работы поиска
tags:
- doka
---Кратко даём основное определение.
Приводим наглядный пример с кодом и визуализацией.
HTML
<div class="element"></div>CSS
.element {
height: 100vh;
background-color: #a91517;
background-image: url("https://l.imgt.es/resource-preview-imgs/1d9806ec-7ef9-49ea-b60c-f1c9ca956b0a%2Fbaymax.crop_316x237_0%252C26.preview.png?profile=max500x190");
background-repeat: no-repeat;
}<iframe title="Описание того, что происходит в демке" src="demos/legend-align/" height="150"></iframe>
👆 Файл index.html с демкой кладём в папку demos, в подпапку с названием демки. Обязательно указываем высоту демки в атрибуте height. В атрибуте title пишем, что в демке происходит, что она иллюстрирует.
Объясняем, как лучше понять этот термин, и в чём его нюансы.
Рассказываем о синтаксисе.
💡 Делимся лайфхаками, которые помогают понять те или иные нюансы.
Рассказываем, как не сесть в лужу, если используешь этот элемент в работе. Создайте в папке статьи подпапку practice, а в ней файл в формате Markdown, названный вашим ником.