README

👋

Citizen

Citizen is a beautiful, usable, responsive MediaWiki skin that makes extensions part of the cohesive experience. It was initially created for the Star Citizen Wiki but is flexible to run on various MediaWiki configurations.

Live demo: English, German, Chinese

For the old design, click here for the last release.

Notable features

Responsive layout: Responsive and able to adapt to different screen sizes. 📱💻🖥️
Light/dark mode: Switch between light and dark mode. ☀️🌙
Improved extension UI: Adjust supported extensions to be more usable and cohesive. 🤝🔗
Reading preferences: Adjust page width, font size, and line height. 👀📃
Collapsible sections: Collapse and expand article sections. 📖📕
Persistent ToC: Access ToC anywhere in the article. 🔍📖
Rich search suggestions: More helpful search suggestions with images and descriptions. 🔍👀
Progressive Web App: Give a more app-like experience when user add your wiki to their home screen. 📱

Installation

Download place the file(s) in a directory called Citizen in your skins/ folder.
Add the following code at the bottom of your LocalSettings.php and after all other extensions:

wfLoadSkin( 'Citizen' );

✔️Done - Navigate to Special:Version on your wiki to verify that the skin is successfully installed.

Configurations

The skin works out of the box without any configurations. The config flags allow more customization on the specific features in the skin. Check out this wiki page on how to adapt Citizen styles on your wiki.

Appearance

Search suggestions

Webapp manifest

$wgCitizenManifestOptions = [
	'background_color' => '#0d0e12',
	'description' => '',
	'short_name' => '',
	'theme_color' => "#0d0e12",
	'icons' => [],
];

Requirements

MediaWiki 1.39.4 or later
For the legacy versions, check the other release branches.

Recommended extensions

These extensions are optional. They are recommended to enable additional feature in Citizen.

PageImages (bundled with MediaWiki) - Add image to search suggestion results
TextExtracts (bundled with MediaWiki) - Add description to search suggestion results
ShortDescription - Add short description to under page title and search suggestion results (needs to set $wgCitizenSearchDescriptionSource to wikidata)
TemplateStylesExtender (if you use TemplateStyles) - Allow the use of CSS variables in TemplateStyles, including the ones provided by Citizen

Extension styles

Citizen overrides some extension styles through skinStyles that applies custom styling to extensions and core libraries.

Grade A - Overhaul - Major adjustments to UI, plus Grade B.
Grade B - Dynamic - Colors are converted into CSS variables, little to none style adjustments.
Grade E - Legacy - Dark mode colors are hardcored as LESS variables. These should be updated to at least Grade B support.

Please feel free to submit PRs if you want to add support for more extensions!

Core

Extensions

Some of the field are tagged as N/A because the information was not tracked before. If you are interested in adding skinstyles, please check out this page on the wiki!

starcitizentools / citizen-skin

Maintainers

Details