Посібник зі стилю
На цій сторінці зафіксовано домовленості щодо стилю на рівні коду для вебсайту OpenTelemetry, які наразі охоплюють шаблони Hugo. Щодо стилю тексту та розмітки Markdown, дивіться натомість Посібник зі стилю документації.
Шаблони Hugo
Відступи
Для читабельності коду використовуйте належні відступи для вкладених блоків коду, зокрема всередині конструкцій {{ if }}, {{ range }} та {{ with }}.
Керування пробілами
Використовуйте тримери обрізання для керування пробілами в Hugo — {{- ... }} та {{ ... -}} — щоб згенерований вивід не містив зайвих порожніх рядків і відступів, зберігаючи при цьому читабельність вихідного коду шаблону.
- Стандартно: обрізання лише справа. Використовуйте
{{ ... -}}— цього зазвичай достатньо, щоб згенерований вивід залишався охайним. - Використовуйте обрізання зліва (
{{- ... }}) або двобічне обрізання ({{- ... -}}) лише коли це виправдано, наприклад, щоб згорнути навколишні порожні рядки. - Вбудовані виводи всередині розмітки не потребують обрізання. Наприклад, конструкція, що виводить значення атрибута, як-от
class="{{ $class }}", не потребує тримерів.
Нові рядки в блоках range
Усередині блоків range розгляньте можливість використання {{ "\n" -}} або {{- "\n" -}}, щоб керувати новими рядками між ітераціями, уникаючи початкових і кінцевих порожніх рядків у згенерованому виводі.