Miss any of our Open RFC calls?Watch the recordings here! »

apostrophe-favicons

2.0.6 • Public • Published

CircleCI

apostrophe-favicons

Editor-controlled favicon generator of various formats. Automatic handling of their link tags.

Overview

Apostrophe module that generates a number of differently sized favicon image formats. The image itself is an apostrophe-images widget that gets appended to the apostrophe-global, which is easily manipulated by an editor.

Unlike version 1.x, this module uses imagemagick to perform image conversions. This is a standard prerequisite for the use of ApostropheCMS with good performance when uploading images, so you should already have it installed in both dev and production environments. See the getting started guide and the production guide.

Note

Performance is much better than 1.x, however there are no options to pass on to the favicon npm module because we do not use it.

Example config

in app.js

var apos = require('apostrophe')({
  shortName: 'yourSite',
  modules: {
 
    // Enable the module, enhances apostrophe-global
    'apostrophe-favicons': {},
    // Now apostrophe-global has some new options
    'apostrophe-global': {
      faviconDestinationDir: '/fav/',
      // Defaults to `/favicons/`. This is an uploadfs path, it will become /uploads/favicons/ on a server
    }
 
  }
});

Outputting the link tags

After you have selected and generated your favicons, you can use the following macro to output the markup into your template.

<!-- in layout.html or something -->
{% extends "outerLayoutBase.html" %}
{% import 'apostrophe-favicons:faviconMacros.html' as favicons %}
...
{% block extraHead %}
  {{ favicons.renderLinks(apos, data.global) }}
{% endblock %}

Install

npm i apostrophe-favicons

DownloadsWeekly Downloads

152

Version

2.0.6

License

MIT

Unpacked Size

22.1 kB

Total Files

13

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar