cdransf/eleventy-tabler-icons-filled
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: initial commit

Browse source
This commit is contained in:
Cory Dransfeldt 2024-03-13 11:40:42 -07:00
parent 3faf8bc4d5
commit 87529d370b
No known key found for this signature in database
2 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -7,7 +7,7 @@ Shortcodes to add [tabler icons](https://tabler-icons.io) to your [Eleventy](htt
Install the package: Install the package:
```sh ```sh
npm i -D eleventy-plugin-tablericons npm i -D @cdransf/eleventy-tabler-icons-filled
``` ```
Then add the plugin to your `.eleventy.js` file: Then add the plugin to your `.eleventy.js` file:
@ -15,23 +15,23 @@ Then add the plugin to your `.eleventy.js` file:
```js ```js
// .eleventy.js // .eleventy.js
module.exports = eleventyConfig => { module.exports = eleventyConfig => {
eleventyConfig.addPlugin(require('eleventy-plugin-tablericons')); eleventyConfig.addPlugin(require('@cdransf/eleventy-tabler-icons-filled'));
} }
``` ```
## Usage ## Usage
This plugin adds the `tablericon` shortcode. This plugin adds the `tablericon-filled` shortcode.
**Note**: These examples use Liquid template syntax, which is the default for Eleventy. If you are using another template engine like Nunjucks, the syntax might be slightly different. **Note**: These examples use Liquid template syntax, which is the default for Eleventy. If you are using another template engine like Nunjucks, the syntax might be slightly different.
### `tablericon` ### `tablericon-filled`
Args: `name: string`, `alt?: string` Args: `name: string`, `alt?: string`
```md ```md
{% tablericon "archive" %} {% tablericon-filled "archive" %}
{% tablericon "x" "Close menu" %} {% tablericon-filled "x" "Close menu" %}
``` ```
## Configuration ## Configuration
@ -46,7 +46,7 @@ Pass the configuration object when adding the plugin:
```js ```js
// .eleventy.js // .eleventy.js
module.exports = eleventyConfig => { module.exports = eleventyConfig => {
eleventyConfig.addPlugin(require('eleventy-plugin-tablericons'), { eleventyConfig.addPlugin(require('@cdransf/eleventy-tabler-icons-filled'), {
className: 'icon', className: 'icon',
errorOnMissing: true errorOnMissing: true
}); });

2
tablericons.js
View file

@ -25,7 +25,7 @@ module.exports = function tablericons(eleventyConfig, config = initialConfig) {
}`; }`;
} }
eleventyConfig.addShortcode("tablericon", function (name, alt, attrs) { eleventyConfig.addShortcode("tablericon-filled", function (name, alt, attrs) {
return tablericons(this, name, alt, attrs); return tablericons(this, name, alt, attrs);
}); });
}; };