mediawiki/bootstrap

Provides the Bootstrap 4 web front-end framework to MediaWiki skins and extensions

4.4.0 2020-09-04 17:54 UTC

README

Build Status Latest Stable Version License

The Bootstrap extension provides the Bootstrap web front-end framework to skins and extensions.

This version of the extension provides Bootstrap 4.3.1.

Requirements

  • PHP 5.6 or later
  • MediaWiki 1.27 or later

Installation

There are two methods for installing Bootstrap. You can select the method that best fits your environment.

Method 1

If you install Bootstrap with Composer, further required software packages will be installed automatically. In this case, it is not necessary to install any dependencies. Composer will take care of that.

  1. On a command line go to your MediaWiki installation directory and run these two commands
COMPOSER=composer.local.json composer require --no-update mediawiki/bootstrap:~4.0

composer update mediawiki/bootstrap --no-dev -o
  1. Load the extension by adding the following line to LocalSettings.php:

    wfLoadExtension( 'Bootstrap' );
  2. Done: Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Remark: It is NOT necessary to install or load any extensions this extensions depends on.

Method 2

If you install Bootstrap without Composer, you will still need to use Composer to install the SCSS library before you enable Bootstrap.

  1. Download Bootstrap and place the file(s) in a directory called Bootstrap in your extensions/ folder.

  2. In the MediaWiki installation directory, add "extensions/Bootstrap/composer.json to the extra/merge-plugin/include section in the file composer.local.json. For example,

{
	"extra": {
		"merge-plugin": {
			"include": [
				"extensions/Bootstrap/composer.json"
			]
		}
	}
}
  1. Still in the MediaWiki installation directory, from a command line run
    composer update.

  2. Add the following code at the bottom of your LocalSettings.php:

wfLoadExtension( 'Bootstrap' );
  1. Done: Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Documentation

See the Bootstrap extension documentation.

It may also be worthwhile to have a look at the Bootstrap site on MediaWiki and the related talk page

Professional Support

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

License

You can use the Bootstrap extension under the GNU General Public License, version 3 (or any later version).