Download the PHP package moritzebeling/kirby-favicon without Composer

On this page you can find all versions of the php package moritzebeling/kirby-favicon. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of moritzebeling/kirby-favicon

Informations about the package kirby-favicon

Kirby Favicon Plugin

This plugin will solve all your favicon worries :)

Installation

Or download/clone this repo into site/plugins of your Kirby project.

🙃 Minimal setup

  1. Inside assets/favicon add favicon.png

The icon should be square, min 180x180px, but why don’t you just do 1024x1024px :)

😎 Recommended setup

  1. Also add a favicon.svg
  2. Inside your HTML <head> element, include the favicon snippet:

If you want to use transparency in your favicon, you should additionally add an app icon. The mask icon will be used in the MacBook Pro Touch Bar, so it should be simple and with transparent background.

If your website has a changing background color, you should set color to false, otherwise I recommend to set it to you primary background color.

🤓 Full configuration

manifest.json

You can add other values according to the specification.

🤨 What will it do?

It will automatically serve the following routes:

Per default, the favicon snippet will print the following HTML:

All sizes can be adjusted through the plugin settings. When minimalist is set to true, all sizes are removed:

When extended option is true, the following is added:

Panel Favicon

https://getkirby.com/docs/reference/system/options/panel#custom-panel-favicon

Research

This solution is an intersection of what many existing Favion generators provide. You can have a look on my research in the repo wiki: https://github.com/moritzebeling/kirby-favicon/wiki

Development

  1. Install a fresh Kirby StarterKit
  2. cd site/plugins
  3. git clone this repo

Roadmap

☕️ Support

If you like this plugin, I would be glad if you would invite me for a coffee via PayPal If you have any ideas for further development or stumble upon any problems, please open an issue or PR. Thank you!

Warranty

This plugin is work in progress and comes without any warranty. Use at your own risk.

All versions of kirby-favicon with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4.0
getkirby/composer-installer Version ^1.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package moritzebeling/kirby-favicon contains the following files

Loading the files please wait ...