Eleventy Plugin that adds support Edge.js template engine

This plugin allows to use Edge.js as template engine for Eleventy.

Installation

npm install @web-alchemy/eleventy-plugin-edgejs

Usage

1const EdgeJsPlugin = require('@web-alchemy/eleventy-plugin-edgejs')
2
3module.exports = function (eleventyConfig) {
4  eleventyConfig.addPlugin(EdgeJsPlugin, {
5    // you can extend current edge instance
6    extendEdgeInstance: async function (edge, eleventyUserConfig) {
7      edge.global('version', '1.0.0')
8
9      edge.registerTag({
10        block: false,
11        seekable: true,
12        tagName: 'rawInclude',
13        compile (parser, buffer, token) {
14          const fileName = token.properties.jsArg.trim()
15          const fullPath = path.join(process.cwd(), eleventyUserConfig.dir.input, fileName)
16          const fileContent = fs.readFileSync(fullPath, 'utf-8')
17          buffer.outputRaw(fileContent)
18        }
19      })
20    },
21
22    // ... or create own new edge instance
23    createEdgeInstance: async function(eleventyUserConfig) {
24      const { Edge } = require('edge.js')
25      
26      const edge = new Edge({
27        cache: false
28      })
29      
30      const { dir } = eleventyUserConfig
31
32      edge.mount(path.join(cwd, dir.input))
33      edge.mount('includes', path.join(cwd, dir.input, dir.includes))
34      
35      return edge
36    },
37
38    // optional condition for skipping template rendering
39    skipRenderCondition: function (inputContent, inputPath) {
40      return inputPath.includes('components')
41    }
42  })
43}

If options has createEdgeInstance function, then extendEdgeInstance will be ignored.

Links

• Edge.js Github Repo
• Edge.js docs
• Edge.js references
• Eleventy