grunt-bake
Advanced tools
Bake external includes into the file to create static pages with no compilation time
Bake static pages for production while using modular files while in development.
This plugin requires Grunt ~0.4.0
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-bake --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks( "grunt-bake" );
This module helps creating static pages while still having the coding comfort of multiple small files. It also helps not to repeat yourself as includes can be used at multiple places.
The module parses the files recursivly, meaning it allows for nested includes. While parsing the includes it also performs a simple find and replace on placeholders. The replacements are supplied in a JSON file but more an here.
When grunt-bake parses files it looks for anchors like this: <!--(bake path/to/file.html)-->.
Setup the bake task like so:
grunt.initConfig( {
bake: {
your_target: {
options: {
// Task-specific options go here.
},
files: {
// files go here, like so:
"dist/index.html": "app/index.html",
"dist/mobile.html": "app/mobile.html"
// etc ...
}
},
},
} )
With a app/index.html file like this one:
<html>
<head></head>
<body>
<!--(bake includes/container.html)-->
<!--(bake includes/footer.html)-->
</body>
</html>
The paths given are relative to the file being parsed.
Type: String
Default value: null
A string value that determines the location of the JSON file that is used to fill the place holders.
Type: String
Default value: ""
A string that determines which subsection of the JSON passed as content should be used. If no section is passed the entire JSON will be used for templating.
Given a content JSON like such:
{
"en": {
"title": "Book",
"info": {
"author": "Joe Do",
"job": "Writer"
}
},
"de": {
"title": "Buch",
"info": {
"author": "Joe Do",
"job": "Schreiber"
}
}
}
If "en" is passed as section, only { "title": "Book" } will be passed to the include. If no section is specified the entire JSON will be passed.
This could be used to parse a template like such:
<div>{{title}}</div>
<div>
<span>{{info.author}}</span>
<span>{{info.job}}</span>
</div>
Type: Function
Default value: null
A Function which is used to process the template before putting it into the file. If no process given or null given the default process is used.
The function gets passed two arguments:
String: representing the template to parse.Object: the content from the JSON file as object.This example shows a simple baking process with all default options.
grunt.initConfig( {
bake: {
build: {
files: {
"app/index.html": "app/base.html"
}
}
}
} )
app/base.html:
<html>
<body>
<!--(bake includes/container.html)-->
</body>
</html>
app/includes/container.html:
<div id="container"></div>
This bake task will create app/index.html:
<html>
<body>
<div id="container"></div>
</body>
</html>
This example shows how to use the bake process to parse the templates with a provided JSON and a section.
grunt.initConfig( {
bake: {
build: {
options: {
content: "app/content.json",
section: "en"
}
files: {
"app/index.html": "app/base.html"
}
}
}
} )
app/content.json:
{
"en": {
"title": "Hello World"
},
"de": {
"title": "Hallo Welt"
}
}
app/base.html:
<html>
<body>
<!--(bake includes/container.html)-->
</body>
</html>
app/includes/container.html:
<div id="container">{{title}}</div>
This bake task will create app/index.html:
<html>
<body>
<div id="container">Hello World</div>
</body>
</html>
In addition to the file the bake anchor tag also allows for inline attributs which will override the content from the JSON file.
Same scenario as above.
app/base.html:
<html>
<body>
<!--(bake includes/container.html title="Salut Monde" name="Mathias")-->
</body>
</html>
app/includes/container.html:
<div id="container">{{title}}</div>
<span>{{name}}</span>
This bake task will create app/index.html:
<html>
<body>
<div id="container">Salut monde</div>
<span>Mathias</span>
</body>
</html>
This example shows the use of a costum process funtion.
var processFunction( source, content ) {
return source + "<br>";
}
grunt.initConfig( {
bake: {
build: {
options: {
content: "app/content.json",
section: "en",
process: processFunction
}
files: {
"app/index.html": "app/base.html"
}
}
}
} )
For ease of development just add the bake task to your watch list. The static page will be baked everytime you change the template.
watch: {
files: [ "app/includes/**" ],
tasks: "bake:build"
}
FAQs
Bake external includes into files to create static pages with no server-side compilation time
The npm package grunt-bake receives a total of 329 weekly downloads. As such, grunt-bake popularity was classified as not popular.
We found that grunt-bake demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.