eleventy-favicons
v1.0.3
Published
Integrating the favicons library into Eleventy
Downloads
44
Readme
eleventy-favicons
A minimal integration of the favicons library into Eleventy, with some future proofing.
- Uses global data, as such also being compatible with template engines without filter/shortcode support
- Allows passing your own favicons options
- Allows providing your own favicons library instance, whilst still providing one by default.
How-to
Basic usage
npm install eleventy-favicons
yarn add eleventy-favicons// .eleventy.js
import eleventyFavicons from "eleventy-favicons";
export default function (eleventyConfig) {
eleventyConfig.addPlugin(eleventyFavicons, { image: "src/favicon.svg"} );
}Then, use it in your templates. The example below uses HTML/Liquid:
<!-- src/example-page.html -->
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
{{favicons}}
</head>Alternatively it also works on templating engines which tend to struggle with global filters/shortcodes. For example, see pug usage below:
//- src/example-page.pug
head
meta(charset="UTF-8")
meta(name="viewport", content="width=device-width, initial-scale=1.0")
title Example page
.
!{favicons}
meta(name="generator", content=eleventy.generator)And that's all you have to do! However, you can customise the behaviour with the methods below.
Passing options to favicons
// .eleventy.js
import eleventyFavicons from "eleventy-favicons";
export default function (eleventyConfig) {
eleventyConfig.addPlugin(eleventyFavicons, {
image: "src/static/logo.svg",
favicons: {
background: "#f4f6a3",
theme_color: "#f4f6a3",
}
});
}Using your own favicons instance
// .eleventy.js
import eleventyFavicons from "eleventy-favicons";
import favicons from "favicons";
export default function (eleventyConfig) {
eleventyConfig.addPlugin(eleventyFavicons, {
image: "src/static/logo.svg",
faviconsLibrary: favicons
});
}Clone locally
git clone https://github.com/Denperidge/eleventy-favicons.git
cd eleventy-favicons
npm installLicense
This project is licensed under the MIT License.