Skip to content

Latest commit

 

History

History
298 lines (208 loc) · 8.38 KB

README.md

File metadata and controls

298 lines (208 loc) · 8.38 KB
Raw

eleventy-plugin-bundle

Little bundles of code, little bundles of joy.

Create minimal per-page or app-level bundles of CSS, JavaScript, or HTML bundles to be included in your Eleventy project.

Makes implementing Critical CSS, per-page in-use-only CSS/JS bundles, SVG icon libraries, secondary HTML content to load via XHR.

Why?

This project is a minimum-viable-plugin for an asset pipeline in Eleventy. It does not perform any transpilation or code manipulation. The code you put in is the code you get out (with configurable hooks for more).

For more complex features you may want to use a more full featured bundler like Vite, Parcel, Webpack, rollup, esbuild, or others.

Bundling has a significant build performance cost, so take care to weigh the cost of using a full-featured Bundler against whether or not this plugin has sufficient functionality for your needs—especially as the platform matures and we see diminishing returns on code transpilation.

Installation

It’s available on npm as @11ty/eleventy-plugin-bundle:

npm install @11ty/eleventy-plugin-bundle

And then in your Eleventy configuration file (probably .eleventy.js):

const bundlerPlugin = require("@11ty/eleventy-plugin-bundle");

module.exports = function(eleventyConfig) {
	eleventyConfig.addPlugin(bundlerPlugin);
};
Full options list

And then in your Eleventy configuration file (probably .eleventy.js):

const bundlerPlugin = require("@11ty/eleventy-plugin-bundle");

module.exports = function(eleventyConfig) {
	eleventyConfig.addPlugin(bundlerPlugin, {
		// Folder (in the output directory) bundle files will write to:
		toFileDirectory: "bundle",

		// Default bundle types
		bundles: ["css", "js", "html"],

		// Shortcode names
		shortcodes: {
			get: "getBundle",
			toFile: "getBundleFileUrl",

			// override bundle add names:
			add: {
				// use `addCss` instead of `css`
				// css: "addCss"
			}
		}
	});
};

Usage

The following shortcodes are provided by this plugin:

  • css, js, and html to add code to a bundle.
  • getBundle and getBundleFileUrl to get bundled code.

Add bundle code in a Markdown file in Eleventy

# My Blog Post

This is some content, I am writing markup.

{% css %}
em { font-style: italic; }
{% endcss %}

## More Markdown

{% css %}
strong { font-weight: bold; }
{% endcss %}

Renders to:

<h1>My Blog Post</h1>

<p>This is some content, I am writing markup.</p>

<h2>More Markdown</h2>

Note that the bundled code is excluded!

Render bundle code

<!-- Use this *anywhere*: a layout file, content template, etc -->
<style>{% getBundle "css" %}</style>

<!--
You can add more code to the bundle after calling
getBundle and it will be included.
-->
{% css %}* { color: orange; }{% endcss %}

Write a bundle to a file

Writes the bundle content to a content-hashed file location in your output directory and returns the URL to the file for use like this:

<link rel="stylesheet" href="{% getBundleFileUrl "css" %}">

Asset bucketing

<!-- This goes into a `defer` bucket (the bucket can be any string value) -->
{% css "defer" %}em { font-style: italic; }{% endcss %}
<!-- Pass the arbitrary `defer` bucket name as an additional argument -->
<style>{% getBundle "css", "defer" %}</style>
<link rel="stylesheet" href="{% getBundleFileUrl 'css', 'defer' %}">

A default bucket is implied:

<!-- These two statements are the same -->
{% css %}em { font-style: italic; }{% endcss %}
{% css "default" %}em { font-style: italic; }{% endcss %}

<!-- These two are the same too -->
<style>{% getBundle "css" %}</style>
<style>{% getBundle "css", "default" %}</style>

Examples

Critical CSS

Use asset bucketing to divide CSS between the default bucket and a defer bucket, loaded asynchronously.

(Note that some HTML boilerplate has been omitted from the sample below)

<!-- … -->
<head>
	<!-- Inlined critical styles -->
	<style>{% getBundle "css" %}</style>

	<!-- Deferred non-critical styles -->
	<link rel="stylesheet" href="{% getBundleFileUrl 'css', 'defer' %}" media="print" onload="this.media='all'">
	<noscript>
		<link rel="stylesheet" href="{% getBundleFileUrl 'css', 'defer' %}">
	</noscript>
</head>
<body>
	<!-- This goes into a `default` bucket -->
	{% css %}/* Inline in the head, great with @font-face! */{% endcss %}
	<!-- This goes into a `defer` bucket (the bucket can be any string value) -->
	{% css "defer" %}/* Load me later */{% endcss %}
</body>
<!-- … -->

Related:

SVG Icon Library

Here svg is an asset bucket on the html bundle.

<svg width="0" height="0" aria-hidden="true" style="position: absolute;">
	<defs>{% getBundle "html", "svg" %}</defs>
</svg>

<!-- And anywhere on your page you can add icons to the set -->
{% html "svg" %}
<g id="icon-close"><path d="…" /></g>
{% endhtml %}

And now you can use `icon-close` in as many SVG instances as you’d like (without repeating the heftier SVG content).

<svg><use xlink:href="#icon-close"></use></svg>
<svg><use xlink:href="#icon-close"></use></svg>
<svg><use xlink:href="#icon-close"></use></svg>
<svg><use xlink:href="#icon-close"></use></svg>

React Helmet-style <head> additions

This might exist in an Eleventy layout file:

<head>
	{% getBundle "html", "head" %}
</head>

And then in your content you might want to page-specific preconnect:

{% html "head" %}
<link href="https://v1.opengraph.11ty.dev" rel="preconnect" crossorigin>
{% endhtml %}

Bundle Sass with the Render Plugin

You can render template syntax inside of the {% css %} shortcode too, if you’d like to do more advanced things using Eleventy template types.

This example assumes you have added the Render plugin and the scss custom template type to your Eleventy configuration file.

{% css %}
  {% renderTemplate "scss" %}
  h1 { .test { color: red; } }
  {% endrenderTemplate %}
{% endcss %}

Now the compiled Sass is available in your default bundle and will show up in getBundle and getBundleFileUrl.

Use with WebC

TODO Coming soon

Bundling on the Edge

Coming soon

Advanced options:

Limitations

  • html bundles do not support nesting or recursion (yet). If this will be useful to you, please file an issue!

Add your own bundle type

If you’d like to add your own bundle types (in addition to css, js, and html), you can do so:

const bundlerPlugin = require("@11ty/eleventy-plugin-bundle");

module.exports = function(eleventyConfig) {
	eleventyConfig.addPlugin(bundlerPlugin, {
		bundles: ["css", "js", "html", "possum"]
	});
};

You could remove existing bundle types too, the bundles array content is not deeply merged. The addition of "possum" in this array:

  1. creates a new possum shortcode for adding arbitrary code to this bundle
  2. adds "possum" as an eligible type argument to getBundle and getBundleFileUrl