MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / skins / vector / README.md

diff --git a/skins/vector/README.md b/skins/vector/README.md
new file mode 100644 (file)
index 0000000..4b3f40b
--- /dev/null
+++ b/skins/vector/README.md
@@ -0,0 +1,26 @@
+Vector Skin
+========================
+
+Configuration options
+---------------------
+
+### $wgVectorPrintLogo
+
+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.
+
+Example configuration:
+
+       $wgVectorPrintLogo = [
+               'url' => 'https://en.wikipedia.org/static/images/mobile/copyright/wikipedia-wordmark-en.svg',
+               'width' => 174,
+               'height' => 27
+       ];
+
+* Type: `Array`
+* Default: `false`