automat

automat

String and markup formatter.

Caveat: This 1.0 has breaking changes from 0.x, in particular the order of parameters for automat.replace and automat.append

Features

• String formatting
  • Text substitution via numbered text substitution patterns
  • Substitution patterns overrideable
  • Optional Extraction of a template from a function comment
  • Optional HTML encoding of substituted text
• DOM node convenience methods convert your formatted markup to DOM nodes and:
  • Return them in a new <div>...</div> element
  • Return them in an existing HTMLElement you provide
  • Append/insert them into an existing HTMLElement you provide

Examples

See tests.

API documentation

Detailed API docs can be found here.

Demo

A demo can be found here.

CDN versions

To use in a browser, you have two options:

1. Incorporate the node module into your own browserified project.
2. Use the browserified versions automat.js or automat.min.js available on the Github Pages CDN.

Submodules

See the note Regarding submodules for important information on cloning this repo or re-purposing its build template.