Skip to content

Working with YAML

Daniel Mundra edited this page Jul 28, 2021 · 5 revisions

Files to help work with YAML

Packages to help convert YAML to JSON

Templating considerations

  • Simple library rather than a larger framework is preferred - our needs are not complex (relative to building full websites), although having a decent library of text processing functions available with options for adding our own would be helpful (we don't need a super minimal 2kb library either).
  • Supports Markdown and other text-based outputs - not just HTML or web component-based (e.g. React).
  • Can be run in a browser as well as as a CLI.
  • Ideally familiar syntax for folks coming from non-JS templating language (Twig, Jinja2, etc).
  • Can accept inputs with minimal processing, allowing people to use their understanding of the YAML structure to identify objects/arrays/keys, etc - this also implies the ability to easily drill into object structures and build nested loops.

Handlebars is probably the leading contender in terms of being established and familiar with a tight focus and fairly minimal dependencies - it appears to support nesting and loops also.

Templating useful links