wikimedia/mediawiki-skins-Vector
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git synced 2024-11-15 03:34:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Mirror of https://gerrit.wikimedia.org/g/mediawiki/skins/Vector
1250 commits 239 branches 5 tags 93 MiB
PHP 39.7%
JavaScript 36.6%
Less 18.4%
Mustache 4.3%
Vue 1%
Go to file
Nicholas Ray 7b7c948bf6 Add 'jsdoc-wmf-theme' to jsdoc 
This adds the wmf theme styles to our jsdoc as can be seen on
https://doc.wikimedia.org/Parsoid/master/.

There is a caveat with this though. jsdoc-wmf-theme adds warnings for
unlinked symbols (e.g. 'return {jQuery}') [1] which causes the jsdoc doc
generation to fail since it is set to fail on warnings (we have it
configured with `pedantic: true`).

If we add the jsdoc-wmf-theme, we will need to be stricter about our
symbol usage which could be a good thing or just be tedious and
annoying.

What do you think?

[1] https://github.com/cscott/jsdoc-wmf-theme/blob/master/publish.js#L29

Bug: T239258
Change-Id: Icade62a278d7e685cbda28a8ca26a1b703e64f19
2020-02-14 10:43:46 -07:00
.phan Upgrade to newer phan 2019-03-20 19:37:59 -07:00
.storybook Add storybook to Vector 2020-01-31 16:59:15 +08:00
dev-scripts Add storybook to Vector 2020-01-31 16:59:15 +08:00
i18n Localisation updates from https://translatewiki.net. 2020-02-11 07:56:02 +01:00
includes Drop usage of mediawiki.skinning.interface module in favor of SkinModule 2020-02-05 10:02:47 +08:00
resources build: Replace JSDuck with JSDoc 2020-02-14 10:29:00 -07:00
screenshots Add skin screenshot for the installer 2017-08-11 15:37:34 -04:00
skinStyles hygiene: Make LESS imports non-ambigious 2019-10-25 20:54:49 +00:00
stories Add storybook to Vector 2020-01-31 16:59:15 +08:00
tests/phpunit/integration Introduce PHPUnit tests in Vector 2020-01-31 16:48:43 +01:00
.eslintrc.json build: Update linters 2019-10-31 21:43:20 +00:00
.gitignore Add storybook to Vector 2020-01-31 16:59:15 +08:00
.gitreview Use track=1 instead of defaultbranch=master in .gitreview 2016-10-24 17:30:32 -07:00
.phpcs.xml Add method scope visibility 2018-11-01 21:01:32 +01:00
.stylelintrc.json build: Bump devDependencies to latest 2018-02-26 10:29:23 -08:00
CODE_OF_CONDUCT.md build: Updating mediawiki/mediawiki-codesniffer to 22.0.0 2018-09-04 01:45:34 +00:00
composer.json build: Updating composer dependencies 2020-01-30 20:11: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
Gruntfile.js build: Replace JSDuck with JSDoc 2020-02-14 10:29:00 -07:00
hooks.txt Remove 'SkinVectorStyleModules' hook 2018-01-26 10:33:47 -08:00
jsdoc.json Add 'jsdoc-wmf-theme' to jsdoc 2020-02-14 10:43:46 -07:00
package-lock.json Add 'jsdoc-wmf-theme' to jsdoc 2020-02-14 10:43:46 -07:00
package.json Add 'jsdoc-wmf-theme' to jsdoc 2020-02-14 10:43:46 -07:00
README.md Add Coding Conventions Section to Vector README 2020-02-05 15:26:15 -07:00
skin.json Drop usage of mediawiki.skinning.interface module in favor of SkinModule 2020-02-05 10:02:47 +08:00
variables.less hygiene: Make LESS imports non-ambigious 2019-10-25 20:54:49 +00:00

README.md

Vector Skin

Installation

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

Development

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

Configuration options

Logo used in print styles. Keys are url, width, and height (in pixels). Note that this solution only works correctly if the image pointed to by url is an SVG that does not specify width and height attributes, or its width and height match the corresponding variables below. Alternatively, a PNG or other type of image can be used, but its dimensions also need to match the corresponding variable below. That in turn may result in blurry images, though.

The URL can be absolute or relative.

Example configuration:

$wgVectorPrintLogo = [
	'url' => 'https://en.wikipedia.org/static/images/mobile/copyright/wikipedia-wordmark-en.svg',
	'width' => 174,
	'height' => 27
];
  • Type: Array
  • Default: false