Razor Leaf is an HTML template engine for Node.js.
Features
automatic escaping
template inheritance
recursive macros
conditional attributes and classes
no extraneous rendered whitespace
no dependencies*
unrestricted JavaScript expressions and inline code; no sandboxes to work around
* This might change.
Example
example.rl:
doctype html head meta charset: "utf-8" meta name: "viewport" content: "initial-scale=1" title "Example" body h1 "Hello, world!" % const { left, right } = data; p "#{left} × #{right} = #{left * right}"
Elements are defined by their names only; no other special character is
necessary.
p
<p></p>
Void elements are recognized automatically.
meta
<meta>
Strings
Strings are double-quoted and escaped for use in HTML as needed. Backslash
escape codes can be used as in JavaScript. No whitespace is added
around strings.
"--> A string <--\n" "A string containing \"double-quotes\""
--> A string <--A string containing "double-quotes"
Strings can also contain interpolated sections, delimited by #{ and }.
#{ can be escaped with a leading backslash; } doesn’t require escaping.
"#{6 * 7}"
42
If an exclamation mark precedes the string, it and any of its interpolated
sections will not be escaped.
!"<!-- A significant comment -->"
<!-- A significant comment -->
Attributes
Attributes are marked up using the syntax name:.
An attribute name can, optionally, be followed by a string to be used as
its value; if a value isn’t provided, the attribute is assumed to be boolean
(and present). Note that a string used as an attribute’s value cannot be “raw”
— that is, cannot be preceded by an exclamation mark.
meta charset: "utf-8"
<meta charset="utf-8">
Classes
Classes are marked up with a leading period, as in .class.
Hierarchy in Razor Leaf is defined using indentation. For example:
doctypehtml head meta charset: "utf-8" title "Example" link rel: "stylesheet" type: "text/css" href: "stylesheets/example.css" body p id: "introduction" "This template is a brief example of hierarchy."
<!DOCTYPE html><html><head><meta charset="utf-8"><title>Example</title><link rel="stylesheet" type="text/css" href="stylesheets/example.css"></head><body><p id="introduction">This template is a brief example of hierarchy.</p></body></html>
Content found after an element on the same line will also be considered that
element’s content.
Comments
Comments begin with # and continue to the end of the line. They do not affect
the rendered HTML.
Code
Line code begins with % and continues to the end of the line. Line code may
contain content (strings, elements, other code blocks, and special blocks, but
not attributes); if it does, the content is treated as a block and wrapped in
curly braces.
For example, this template:
% function countTo(n) % for (var i = 1; i <= n; i++) "#{i}"% countTo(5);
might compile to this JavaScript:
function countTo(n) { for (var i = 1; i <= n; i++) { output += i; }}countTo(5);
Block code begins with do and treats all of its content as JavaScript.
do const compareKeys = (a, b) => a.key < b.key ? -1 : a.key > b.key ? 1 : 0; const sorted = (array, by) => array .map(value => ({key: by(value), value})) .sort(compareKeys) .map(({value}) => value);for post in sorted(posts, post => post.title) post-detail(post)
Special blocks
Some names define special blocks. These are:
doctype: Inserts <!DOCTYPE html>.
if (condition): Includes its content only if condition is met.
elif (condition): Can immediately follow an if or an elif.
else: Can immediately follow an if or an elif.
for (identifier) of (collection): Includes its content for each element of the array or array-like object collection.
for (identifier), (index) of (collection): Allows the index variable in a for loop to be named.
include (name): Loads and includes another template.
extends (name): Loads another template and replaces its blocks. A template that extends another template cannot have any content outside of block actions.