Пишу на этом сайте

Это авторская документация и пример рабочего макета. Обычные статьи представляют собой файлы Markdown в формате _posts/ с коротким заголовком YAML. Полный локальный рабочий процесс см. в репозитории maintenance/AUTHOR_GUIDE.md.

Небольшой файл Markdown

title: A useful observation
date: 2026-10-28
lang: en
tags: [engineering]

Поместите --- до и после этого заголовка. Тогда напишите статью под ней. Используйте lang: ar для арабского языка или lang: ru для русского. Пост не нуждается в переводе.

Код и уравнения

Огражденные блоки кода используют название языка для выделения:

voltage = 230
current = 5
power = voltage * current
print(power)

Устанавливайте math: true в начале только тогда, когда на странице нужны уравнения. MathJax обслуживается локально и загружается только на этих страницах. Например, полная мощность:

\[S = V I^{*}\]

Это уравнение является примером набора текста, а не результатом проекта.

Изображения и подписи

Используйте осмысленный альтернативный текст. В качестве подписи используйте небольшую фигуру HTML в Markdown:

Символы подключения трансформатора и смещения фаз из оригинальной статьи.
Существующая иллюстрация из статьи о подключениях трансформатора; сохраняется во время миграции.

Ссылки в документации

Используйте ссылки на относительные каталоги: следующий: static imports. Импортированный пакет имеет собственный пример страницы под /docs/static-example/.

Переводы

Дайте реальные аналоги такого же translation_key. Каждый хранит свой собственный URL-адрес и lang. Макет предлагает ссылки только на опубликованные аналоги. Страницы на арабском и русском языках, ссылки на которые приведены выше, представляют собой переведенные авторские примеры.