posthtml-favicons
v1.4.0
Published
PostHTML Favicon generator
Downloads
907
Readme
PostHTML Favicon Generator Plugin
This module is using favicons to generate all of favicons based on a single image
Usage
Use a simple <link> tag to include your favicon. This plugin will add other related tags and writes generated images to disk.
<html>
<head>
<link rel="icon" href="path/to/icon.png" />
</head>
<body></body>
</html>Options
See the Options interface in src/index.ts
For favicon configurations see favicon repo:
https://github.com/evilebottnawi/favicons#nodejs
Example
const favIconPlugin = require("posthtml-favicons");
const html = `
<!doctype html>
<html>
<head>
<link rel="icon" href="my-icon.png" />
</head>
<body>
</body>
</html>`;
posthtml()
.use(favIconPlugin({ outDir: "./dist", configuration: { path: "/icons" } }))
.process(html)
.then((res) => {
// files are written to dist folder
// res.html has new tags
});Using with Parcel Bundler
There is an example repo for demonstrating usage with Parcel Bundler