sjablong
TypeScript icon, indicating that this package has built-in type declarations

1.0.33 • Public • Published

Sjablong

Templating engine with the combined powers of handlebars, front-matter, JSON Schema and Sjablong-fields

What can Sjablong do?

  • Replace placeholders in text (Sjablong-fields, mustache or handlebars-expressions)
  • Generate JSON Schema from Sjablong-fields and validate data against it
  • Have default values for the template by front-matter or Sjablong-fields
  • Convert Markup to HTML

Sjablong-fields

A Sjablong-field starts with [[ and ends with ]]
Inbetween the tags you define keyvalue-pair in the format key="value"
The only required key in a Sjablong-field is path. This it path in the data it should be replaced with. The Sjablong-fields can be used to generate a JSONSchema to validate the data with.

Field examples

Key Description Required Example
label Name/title of the field No Fornavn
path The path in the data object it should be replaced with Yes name.firstname
description Description of the field No Firstname of the recipient
required Should the field be required? No true
default The default value of the field No Bjarne
preview If replacePlacehold's preview option is true No Bjarne

Examples

Sjablong-felt on a single line

[[label="fornavn":path="name.firstname"]]

Sjablong-felt with multiline default value

[[label="test":path="test":default="Line1\nLine2\nLine3"]]

Sjablong-felt on multiple lines (It is not necessary to indent the pairs)

[[
  label="fornavn"
  path="name.firstname"
]]

Sjablong-felt on multiple lines with more fields

[[
  label="fornavn"
  path="name.firstname"
  descriptione="First name of the recipient"
  required="true"
  default="Max"
  preview="Bjarne"
]]

Readme

Keywords

none

Package Sidebar

Install

npm i sjablong

Weekly Downloads

0

Version

1.0.33

License

ISC

Unpacked Size

47.8 kB

Total Files

28

Last publish

Collaborators

  • karl-einarb