Liquid JS

Общая идея

Liquid JS — это шаблонный язык, который позволяет добавлять логику и динамическое поведение непосредственно в текст документа.

В проекте Liquid JS используется поверх Markdown, дополняя его, но не заменяя.

INFO

Markdown описывает, что написано.
Liquid JS описывает, как это связано.

Задачи Liquid JS в документах

Liquid JS используется для:

• работы с переменными;
• автоматической подстановки значений;
• управления нумерацией;
• создания ссылок на элементы документа;
• условного отображения частей текста.

Благодаря этому документ перестаёт быть статичным и становится логически связанным.

Примеры использования

Вывод значения переменной

{{ variable }}

В момент рендеринга вместо конструкции подставляется текущее значение переменной.

Это позволяет централизованно управлять данными, например названием работы или именем автора.

Ссылки и нумерация элементов

{{ Ref.RefLink.index }}

Этот вызов используется для вставки номера элемента (формулы, таблицы, рисунка, источника литературы и т.д.).

Номер:

• всегда актуален;
• пересчитывается автоматически;
• не требует ручного контроля.

Условный вывод текста

{% if showAppendix %}
Текст приложения
{% endif %}

Такой подход позволяет:

• включать или исключать части документа;
• не дублировать текст;
• адаптировать документ под разные требования.

Контролируемая сложность

Liquid JS используется в проекте осознанно и ограниченно.

Для большинства задач достаточно:

• понимания переменных;
• базовых условий;
• ссылок на элементы.

Глубокое знание языка не требуется, а сложная логика выносится из текста документа.

Для более детального изучения возможностей Liquid JS рекомендуется ознакомиться с официальной документацией.