Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ashur/eleventy-toolkit
Common filters and shortcodes for use with Eleventy
https://github.com/ashur/eleventy-toolkit
eleventy
Last synced: 10 days ago
JSON representation
Common filters and shortcodes for use with Eleventy
- Host: GitHub
- URL: https://github.com/ashur/eleventy-toolkit
- Owner: ashur
- Created: 2022-09-18T18:17:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-13T20:23:28.000Z (about 1 year ago)
- Last Synced: 2025-01-19T21:50:58.429Z (17 days ago)
- Topics: eleventy
- Language: JavaScript
- Homepage:
- Size: 441 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# eleventy-toolkit
Common filters and shortcodes for use with Eleventy
## Usage
To install this plugin, run the following command at the root of your Eleventy project:
```shell
npm install ashur/eleventy-toolkit#semver:^v0.3.2
```
Next, include the following in your [Eleventy config file](https://www.11ty.dev/docs/config/):
```javascript
module.exports = (eleventyConfig) => {
eleventyConfig.addPlugin(require("@aaashur/eleventy-toolkit"));
};
```
### Options
Filters, shortcodes, and paired shortcodes may support configuration options, which can be set using the `pluginOptions` object:
```javascript
module.exports = (eleventyConfig) => {
const toolkitOptions = {
filters: {
cssmin: {
minify: true, // always minify CSS
options: {
// CleanCSS options
},
},
},
shortcodes: {
includeGlob: {
includesDir: __dirname + "/src/_includes",
},
},
};
eleventyConfig.addPlugin(
require("@aaashur/eleventy-toolkit"),
toolkitOptions,
);
};
```
> See [filters](https://github.com/ashur/eleventy-toolkit/blob/main/src/filters/README.md) and [shortcode](https://github.com/ashur/eleventy-toolkit/blob/main/src/shortcodes/README.md) documentation for details.