https://github.com/apostrophecms/favicon

Edit the favicon (the icon in the browser tab) within ApostropheCMS
https://github.com/apostrophecms/favicon

Last synced: about 2 months ago
JSON representation

Edit the favicon (the icon in the browser tab) within ApostropheCMS

• Host: GitHub
• URL: https://github.com/apostrophecms/favicon
• Owner: apostrophecms
• License: mit
• Created: 2024-02-14T20:50:19.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-09-10T17:40:38.000Z (4 months ago)
• Last Synced: 2024-09-10T19:50:26.908Z (4 months ago)
• Language: JavaScript
• Size: 37.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  


  
Favicons for ApostropheCMS

  


    

      

    

    

      

    

  



This module allows users to edit the "favicon" (browser tab icon) of the site via the global settings of the site.

As such, it pairs well with the Apostrophe palette and multisite modules.

## Installation

To install the module, use the command line to run this command in an Apostrophe project's root directory:

```

npm install @apostrophecms/favicon

```

## Usage

Configure the `@apostrophecms/favicon` module in the `app.js` file:

```javascript

require('apostrophe')({

  shortName: 'my-project',

  modules: {

    '@apostrophecms/favicon': {}

  }

});

```

You do not have to do anything else. You can access the global settings of the site

via the "Gear" button in the upper right. Once there, select the "Favicon" tab and

choose your preferred image. Note that a square portion of the image is automatically

cropped if you do not use the cropping interface manually.

There are no special requirements for images uploaded for this purpose, however you may

wish to use a PNG file in order to achieve transparency effects.

> Browsers vary in terms of how quickly you will see the new favicon image, but a

> page refresh usually suffices.