See also contributing/liquid-helpers.md
This directory contains custom Liquid tags for outputting dynamic content. These custom tags exist for a few reasons:
- Content and styling should be separated. Writers should not be concerned with writing or maintaining stylistic markup.
- Content should be localized to match the current language.
- Styling and markup should be DRY and reusable.
Tags can be used in:
- Articles and TOCs (
content/**/*.md) - Include files (
includes/*.html)
Tags always expect a single argument, a language agnostic href:
{% data variables.product.product_name %}| Markup | Renders |
|---|---|
{% indented_data_reference foo.bar spaces=NUMBER %} |
A data reference with the specified number of spaces prepended to each line. Defaults to 2 spaces if no spaces included. For example: {% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} |
Each custom tag has the following:
- a JavaScript class in
lib/liquid-tags/ - an HTML template in
includes/liquid-tags/
The class and the template should have corresponding names, like lib/liquid-tags/my-tag.js and includes/liquid-tags/my-tag.html
You must also register the new tag in lib/render-content/index.js with a line like this:
renderContent.liquid.registerTag('my_tag', require('./liquid-tags/my-tag'))