metalsmith-bundles
Advanced tools
Readme
Handles javascript and css resources as bundles for easy (conditional) inclusion in templates.
Most of the time when you make use of some library you need to include different resources in your page templates, in different places actually. Take highlight.js as an example, it's likely you will include the language styles in the head section and the related javascript at the bottom of the page. You will also need a custom little piece of javascript that renders the highlight when the page is loaded.
Further more, you don't want to include all these resources in all the pages, only in the pages where you need to highlight some code.
This plugin helps to organize all these resources in a way you only need to specify the bundle you want to load in the front matter of the pages where you really need it.
npm install metalsmith-bundles
A bundle is a directory that contains three files, each of them represents a section where the resources are included.
├── /path/to/bundles
├── highlightjs
│ ├── footer.html
│ ├── head.html
│ └── page.html
In each of the files you might want to have the inclusion of the needed resources, let's say:
// head.html
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/styles/monokai-sublime.min.css" />
// footer.html
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/languages/javascript.min.js"></script>
<script>
hljs.initHighlightingOnLoad();
</script>
// page.html is empty in this case
To tell a page to use a bundle you just have to specify it in the front matter, the key is the directory name you created before.
// post.md
---
title: A post
description: A very simple post.
bundles:
- highlightjs
---
<h1> {{ title }} </h1>
At this point you probably have a layout, let's tell Handlebars to include the needed resources.
...
<head>
{{ bundles 'head' }}
</head>
<body>
{{{ contents }}}
<footer>
{{ bundles 'footer' }}
</footer>
</body>
...
The page section is meant to be included at the end of the content, you might include it at the end of your post template in the same way if needed: {{ bundles 'page' }}.
var handlebars = require('handlebars');
var bundles = require('metalsmith-bundles').bundles;
var hbtbundles = require('metalsmith-bundles').registerBundles(handlebars);
new Metalsmith(__dirname)
.use(bundles({
directory: '/path/to/bundles'
}))
.build();
In this example only the post.md file will have all the resources, if you need the same in other pages you just have to specify the bundle name in the front matter.
options Objectdirectory String
The directory where the bundles definitions are.
extension String
Optional. The extension of each of the files defining a bundle section.
MIT License, see LICENSE for details.
FAQs
Handles javascript and css resources as bundles for easy (conditional) inclusion in templates
We found that metalsmith-bundles demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.