mediawiki/font-awesome

Provides the FontAwesome icon font, CSS, and SVG framework in the wiki

Fund package maintenance!
JeroenDeDauw

Installs: 397

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 5

Forks: 0

Language:JavaScript

Type:mediawiki-extension

1.0 2019-10-20 04:05 UTC

This package is auto-updated.

Last update: 2020-11-21 07:55:09 UTC


README

Build Status Latest Stable Version Packagist download count

The FontAwesome extension to MediaWiki provides parser functions to insert Font Awesome Free icons into the wiki text.

Currently Font Awesome Free, version 5.11.2 is included.

Requirements

  • PHP 7.0 or later
  • MediaWiki 1.31 or later

Installation

Using Composer

Using Composer is the recommended way to install this extension.

Run the following commands from the MediaWiki installation directory:

  1. COMPOSER=composer.local.json php composer.phar require --no-update mediawiki/font-awesome ^1.0
  2. php composer.phar update --no-dev mediawiki/font-awesome

To update the extension run the last command again.

Using a download from GitHub

  1. Download a tar ball or zip file from GitHub
  2. Extract it into the extensions directory of your MediaWiki installation
  3. Rename the folder mw-font-awesome-... to FontAwesome

To update the extension delete the FontAwesome folder completely and re-install.

Activation

Add the following line to your LocalSettings.php:

wfLoadExtension( 'FontAwesome' );

Configuration

There are two render modes available for FontAwesome icons:

  • Web Fonts with CSS: This implementation uses web fonts as the file format and relies on the browser to render icons as it would any custom font.
  • SVG with JavaScript: This implementation encodes icon data and the mechanism to display them in the browser in JavaScript code that the browser executes.

The render mode can be selected by setting the variable $wgFaRenderMode in LocalSettings.php. Allowed values are: webfonts (default) and javascript.

Example: $wgFaRenderMode = 'javascript';

For a discussion of the advantages and drawbacks of the render modes see Performance & Font Awesome on fontawesome.com.

Usage

This extension defines three parser functions:

  • {{#far:...}} to insert an icon from the FontAwesome Regular font
  • {{#fas:...}} to insert an icon from the FontAwesome Solid font
  • {{#fab:...}} to insert an icon from the FontAwesome Brands font

Example: {{#fab:wikipedia-w}} will insert the Wikipedia-W

For valid icon names see https://fontawesome.com/icons.

Professional Support

The FontAwesome extension is maintained by Professional.Wiki. You can contract us to help you with installation or customization of FontAwesome. We also do development work.

License

GNU General Public License, Version 3 or later.

The Font Awesome Free package is included in the extension. See its license file for details.