gulp-dry
Gulp plugin for Dry, a new template engine with advanced inheritance features.
Table of Contents
(TOC generated by verb using markdown-toc)
Install
Install with npm:
$ npm install --save gulp-dry
Usage
var dry = ; gulp;
Examples
Visit dry for more information.
Blocks
Define blocks in a template:
<!-- parent.html --> {% block "head" %} Document {% endblock %} {% block "body" %} Default body. {% endblock %} {% block "footer" %} Default footer. {% endblock %}
You can extend the parent.html
template like this:
{% extends "parent.html" %} {% block "head" %}Inherited!{% endblock %} {% block "body" %}This is the body{% endblock %} {% block "footer" %}This is the footer{% endblock %}
Resulting in:
<!-- parent.html --> Inherited! This is the body This is the footer
Layouts
Layouts are used for "wrapping" files with common code or content. Layouts can also use blocks, but the strategy for merging them is different. Unlike blocks, when using layouts:
- text nodes from child and parent templates are preserved
- text nodes from child templates that do not belong to a specific block will be rendered into the
body
block of the parent layout - layouts may be defined using a
{% body %}
tag, or a{% block "body" %} {% endblock %}
tag
Layout body block
Example layout template with a body
tag:
<!-- some-layout.html --> Document {% body %}
When used by another template, like this:
<!-- some-file.html -->{% layout "some-layout.html" %}This is content.
Results in:
Document This is content.
Layout body block
If you need to define placeholder content, you can define a block
instead:
<!-- some-layout.html --> Document {% block "body" %} Default content. {% endblock %}
When used by another template, like this:
<!-- some-file.html -->{% layout "some-layout.html" %}This should overwrite the default content.
Results in:
Document This should overwrite the default content.
About
Related projects
- dry: Template engine with support for block helpers, advanced inheritance features, and more. | homepage
- is-glob: Returns
true
if the given string looks like a glob pattern or an extglob pattern… more | homepage - matched: Adds array support to node-glob, sync and async. Also supports tilde expansion (user home) and… more | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Building docs
(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verb
Running tests
Install dev dependencies:
$ npm install -d && npm test
Author
Jon Schlinkert
License
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb-generate-readme, v0.1.28, on August 09, 2016.