StarCitizenTools/mediawiki-skins-Citizen
1
0
Fork 0
mirror of https://github.com/StarCitizenTools/mediawiki-skins-Citizen.git synced 2024-11-27 07:41:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
A beautiful, usable, responsive MediaWiki skin with in-depth extension support. Originally developed for the Star Citizen Wiki.
747 commits 5 branches 122 tags 93 MiB
Less 82.2%
JavaScript 9.4%
PHP 7.1%
Mustache 1.3%
Go to file
alistair3149 abbde42c0e
WIP: Added HSTS documentation
2020-03-26 15:30:26 -04:00
.github Updated msg in workflow 2020-01-06 15:39:32 -05:00
bin Force phpcbf to exit with 0 2019-12-30 19:04:02 -05:00
i18n Add search string to no result card 2020-01-01 02:27:48 +01:00
includes Attempt to fix autocomplete on search form 2020-03-17 18:34:01 -04:00
licenses Updated font licenses 2019-12-20 13:18:12 -05:00
resources Tweaked animation speed to be more responsive 2020-03-21 00:41:45 -04:00
skinStyles Tweaked animation speed to be more responsive 2020-03-21 00:41:45 -04:00
.eslintignore Added eslint ignore file 2020-02-15 19:20:59 -05:00
.eslintrc.json Enable common js 2020-02-15 17:24:52 -05:00
.gitignore Bumped version and updated test files 2019-12-26 02:08:10 -05:00
.phpcs.xml Exclude out folder for phpcs 2020-01-06 14:49:06 -05:00
.stylelintrc.json Make stylelint ignore out 2019-12-26 13:02:30 -05:00
citizen.php Made code MW compliant 2019-12-26 00:24:31 +01:00
CODE_OF_CONDUCT.md Add documentation to the skin 2019-12-21 00:56:15 -05:00
composer.json Supress composer error 2020-01-09 19:32:29 -05:00
Gruntfile.js Attempt to fix eslint error 2020-02-15 19:13:03 -05:00
jsdoc.json Updated JSDOC config 2019-12-26 13:06:28 -05:00
LICENSE licensing update 2019-08-16 21:48:16 -04:00
package-lock.json Let NPM regenerate package-lock 2020-03-15 00:30:17 -04:00
package.json Attempt to fix autofix 2019-12-28 19:13:50 -05:00
README.md WIP: Added HSTS documentation 2020-03-26 15:30:26 -04:00
skin.json Bump version 2020-03-16 00:49:23 -04:00

README.md

Citizen

Citizen is a responsive skin for MediaWiki built by the Star Citizen Wiki team. Although it is specifically built for the Star Citizen Wiki, the skin should be able to run on any Mediawiki installation that is 1.31 or higher. Due to resource constraints, we might not be able to provide full support for setups that are vastly different than us, but please feel free to submit patches or bug report!

Live demo can be seen at the Star Citizen Wiki.

Notable features

  • Fully responsive skin: Responsive and able to adapt to different screen sizes. 📱💻🖥️
  • Rich search suggestions: More helpful search suggestions with images and descriptions. 🔍👀
  • Lazyload images: Improve load time of your wiki and avoid unnessecary image downloads. 🚀
  • Native light/dark mode support: Respect OS and app configuration for light and dark mode. ☀️🌙
  • Webapp manifest: Give a more app-like experience when user add your wiki to their home screen. 📱
  • HTTP security response headers: Enhance the security of your wiki from HTTP response headers. 🔒🔑

Configurations

Search suggestions

Name Description Values Default
$wgCitizenSearchDescriptionSource Source of description text on search suggestions wikidata - Use description provided by WikibaseLib or ShortDescription; textextracts - Use description provided by TextExtracts; pagedescription - Use description provided by Description2 or any other extension that sets the description page property textextracts
$wgCitizenMaxSearchResults Max number of search suggestions Integer > 0 6

Security-related

Content Security Policy (CSP)

Name Description Values Default
$wgCitizenEnableCSP Enable or disable Content Security Policy, as an alternative to $wgCSPHeader in Mediawiki 1.32+ true - enable; false - disable false
$wgCitizenEnableCSPReportMode Enable or disable CSP report only mode, overrides $wgCitizenEnableCSP true - enable; false - disable false
$wgCitizenCSPDirective The string of yourr CSP directive See the Content Security Policy page ``

HTTP Strict Transport Security (HSTS)

Name Description Values Default
$wgCitizenEnableHSTS Enable or disable HTTP Strict Transport Security true - enable; false - disable false
$wgCitizenHSTSMaxAge Time in second that the browser should remember that a site is only to be accessed using HTTPS Integer > 0 300
$wgCitizenHSTSIncludeSubdomains Apply HSTS to all of the site's subdomains true - enable; false - disable false
$wgCitizenHSTSPreload Enable or disable HSTS preload true - enable; false - disable false

Webapp manifest

Name Description Values Default
$wgCitizenEnableManifest Enable or disable web app manifest true - enable; false - disable true
$wgCitizenManifestThemeColor Theme color of the web app manifest Hex color code #11151d
$wgCitizenManifestBackgroundColor Background color of the web app manifest Hex color code #fff

Miscellaneous

Name Description Values Default
$wgCitizenThemeColor The color defined in the theme-color meta tag Hex color code #11151d

Requirements