Getting started

Installation

Install from npm. Node v22 or higher is required.

npm install -D @lowfat/eleventy-plugin-lfp-shortcodes

Add the plugin in your .eleventy.js/eleventy.config.js/eleventy.config.mjs:

import shortcodes from '@lowfat/eleventy-plugin-lfp-shortcodes';

export default async function(eleventyConfig) {
    // your configurations
    eleventyConfig.addPlugin(shortcodes, options);
}

Continue reading to learn about configuration via options.

Configuration

The plugin offers a plethora of options, regarding styling and functionality for each shortcode.

Configuration and customization is two-fold:

1. Configuration for essential functionalities can be done by passing certain arguments when calling the shortcode in your template. To learn more about these configurations, have a look at each individual shortcode.
2. Passing a configuration file to the plugin is another way to customize the library's plugins.