Choose Your Template Engine
Bridgetown’s default configured template language is Liquid. Liquid’s simple syntax and safe execution context making it ideal for designer-led template creation.
However, you can use a variety of different template engines within Bridgetown simply by using the appropriate file extension (aka
.erb), or by specifying the template engine in your resource’s front matter. Out of the box, Bridgetown provides support for both ERB and Serbea, and you can also use Haml or Slim by installing additional plugins.
To configure a new Bridgetown site to use a language other than Liquid as the default template engine regardless of file extension, use the
--templates option when running
For documentation on how to use Liquid or Ruby-based syntax in Bridgetown content and templates:
Why Switch from Liquid? #
Liquid is a great way to start out if you’re not that familiar with Ruby, because it feels more akin to template engines like Mustache, Jinja, Nunjucks, Twig, and so forth. Simple tags and filters, along with loops and conditional statements, let you construct templates quickly and easily.
But if you need more power (especially when writing components) or you’re already familiar with Ruby and engines such as ERB, then the cognitive overhead to learn and stick with Liquid can actually become a hindrance. In addition, it’s an important goal for Bridgetown to integrate well with a development workflow which already incorporates the Ruby on Rails framework. Or perhaps you’re looking to switch from Middleman which uses ERB by default.
In any case, the ability to “pick your flavor” of template engines on a site-by-site or file-by-file basis is one of Bridgetown’s core strengths as a web framework.
Per-file Engine Configuration #
When the default Liquid template engine is configured, Bridgetown processes files through Liquid even when they don’t have a
.liquid extension. For example,
authors.html will all get processed through Liquid during the build process.
As an initial step, you can use a different template engine based on extension alone. For example,
authors.erb would get processed through ERB and output as
authors.html. But there are a couple of drawbacks to that approach. If you wanted
posts.erb to be output as
posts.json, you’d have to manually set a
permalink in your front matter. In addition, if you wanted to write a document in Markdown but add ERB tags in as well, you couldn’t do that via file extension alone because the Markdown converter looks for files ending in
So instead of doing that, you can switch template engines directly. All you need to do is use the
template_engine front matter variable. You can do this on any page, document, or layout. For example, you could write
posts.json but add
template_engine: erb to the front matter, and then you’d be all set. Write your template using ERB syntax, get
posts.json on output. In the Markdown scenario, you could still author
about.md while adding ERB tags to the content, and it would work exactly as you expect.
Front Matter Defaults #
template_engine directly in your file’s front matter, you could use front matter defaults to specify a template engine for a folder or folder tree or files which match a particular “glob pattern”. That way you could, say, use Liquid for most of the site but use ERB just for a certain group of files.
Site-wide Configuration #
Most likely, however, you’ll want to switch your site wholesale from one engine to another. That’s where
bridgetown.config.yml comes in. Simply add
template_engine: erb right in your config, and suddenly everything will get processed through ERB regardless of file extension. (This will have been done for you if you used the
-t option when running
bridgetown new.) Serbea works in the same manner:
template_engine: serbea. Write HTML, XML, Markdown, JSON, CSV, whatever you like—and still access the full power of your Ruby template language of choice. You don’t even need to give up on Liquid completely—just save files with
.liquid or use
template_engine: liquid front matter.
While it’s true you can use ERB or Serbea site-wide, the Haml and Slim plugins do not allow site-wide configuration. That’s because both Haml and Slim start with pure HTML/XML output using special syntax, and if you want to do something else like write Markdown or JSON, you’ll have to use their “embedded” language support. Read their documentation for further details.
It’s Up to You #
Regardless of which template engine you pick, whether it’s Liquid, ERB, Serbea, or something else, Bridgetown has got you covered. We continue to look for ways to make switching engines easier while reducing the number of “sharp edges” that can arise to differences in how various template engines process content, so please don’t hesitate to let us know if you run in to any issues.