Custom Vector theme/skin for GolemWiki, our instance of MediaWiki
Go to file
jdlrobson 6f16af4212 Round up to nearest kb
The precision we are currently using leads to lots of issues with
core changes and as we grow the new vector.

I think checking in at every 1kb margin seems like a better state
of play for now.

Bug: T270883
Change-Id: Iaa4fb44a471777fdebfb906c465ea67b5bdb3903
2021-02-11 16:51:41 +00:00
.phan Upgrade to newer phan 2019-03-20 19:37:59 -07:00
.storybook Set strictUnits to true for LESS, and fix units in the code 2020-10-16 23:42:57 +00:00
dev-scripts [Storybook] Fix PNG/SVG asset resolution. 2020-09-25 12:52:05 +02:00
i18n Localisation updates from https://translatewiki.net. 2021-02-11 08:43:52 +01:00
includes Simplify responsive Vector implementation 2021-02-10 13:05:14 +00:00
resources Convert max-width layout to relative units 2021-02-10 22:58:14 +01:00
screenshots Add skin screenshot for the installer 2017-08-11 15:37:34 -04:00
skinStyles Language button - design fixes 2021-02-08 19:03:02 +00:00
stories Simplify menu code 2021-01-04 19:02:34 +00:00
tests Add mw-interlanguage-selector class to language button & hide menu/arrow when appropriate 2021-02-05 15:03:07 -07:00
.eslintignore Replace Grunt tasks with npm scripts in package.json 2020-02-27 16:32:12 +01:00
.eslintrc.json build: Updating stylelint-config-wikimedia to 0.10.3 2020-11-23 03:44:23 +00:00
.gitignore [Storybook] Fix PNG/SVG asset resolution. 2020-09-25 12:52:05 +02:00
.gitreview Use track=1 instead of defaultbranch=master in .gitreview 2016-10-24 17:30:32 -07:00
.nvmrc [build] Add NVM configuration 2020-07-31 02:25:21 +00:00
.phpcs.xml build: Updating mediawiki/mediawiki-codesniffer to 33.0.0 2020-11-17 23:33:50 +01:00
.stylelintignore Replace Grunt tasks with npm scripts in package.json 2020-02-27 16:32:12 +01:00
.stylelintrc.json build: Bump devDependencies to latest 2018-02-26 10:29:23 -08:00
.svgo.yml build: Add 'svgo', SVG minifier script and unify SVGO rules 2020-03-07 19:47:58 -08:00
CODE_OF_CONDUCT.md build: Updating mediawiki/mediawiki-codesniffer to 22.0.0 2018-09-04 01:45:34 +00:00
COPYING Use the plain-text GPL and fix 'license-name' to match SPDX conventions 2015-01-29 17:04:29 +01:00
Doxyfile docs: Generate documentation with Doxygen 2020-02-24 16:49:38 +00:00
README.md Add nvm to README 2020-10-19 18:07:12 +00:00
bundlesize.config.json Round up to nearest kb 2021-02-11 16:51:41 +00:00
composer.json build: Updating mediawiki/mediawiki-phan-config to 0.10.6 2020-12-23 07:15:01 +00:00
jsdoc.json Integrate WVUI search into Vector 2020-12-08 13:27:12 -08:00
package-lock.json build: Updating npm dependencies 2021-01-08 04:48:46 +00:00
package.json build: Remove maxWarnings: 0 from eslint configuration 2021-02-05 20:16:27 +01:00
skin.json Switch back to skin version 1 for now 2021-02-11 14:20:09 +00:00
tsconfig.json [JavaScript] Validate types 2020-03-16 09:10:08 -06:00
variables.less Fix z-index of navigation menus 2020-12-18 18:51:44 +01:00

README.md

Vector Skin

Installation

See https://www.mediawiki.org/wiki/Skin:Vector.

Configuration options

See skin.json.

Development

Node version

It is recommended to use nvm to use the version of node defined in .nvmrc during local development. This ensures consistency amongst development environments.

Coding conventions

We strive for compliance with MediaWiki conventions:

https://www.mediawiki.org/wiki/Manual:Coding_conventions

Additions and deviations from those conventions that are more tailored to this project are noted at:

https://www.mediawiki.org/wiki/Reading/Web/Coding_conventions

URL query parameters

Skin preferences

Vector defines skin-specific user preferences. These are exposed on Special:Preferences when the VectorShowSkinPreferences configuration is enabled. The user's preference state for skin preferences is used for skin previews and any other operation unless specified otherwise.

Version

Vector defines a "version" preference to enable users who prefer the December 2019 version of Vector to continue to do so without any visible changes. This version is called "Legacy Vector." The related preference defaults are configurable via the configurations prefixed with VectorDefaultSkinVersion. Version preference and configuration may be overridden by the useskinversion URL query parameter.

Pre-commit tests

A pre-commit hook is installed when executing npm install. By default, it runs npm test which is useful for automatically validating everything that can be in a reasonable amount of time. If you wish to defer these tests to be executed by continuous integration only, set the PRE_COMMIT environment variable to 0:

$ export PRE_COMMIT=0
$ git commit

Or more succinctly:

$ PRE_COMMIT=0 git commit

Skipping the pre-commit tests has no impact on Gerrit change identifier hooks.

Hooks

See hooks.txt.