Skip to content

Configuration ​

Citizen works out of the box without any configurations!

The skin configs allow more customization on the specific features in the skin.

Appearance ​

$wgCitizenHeaderPosition ​

Determines where the site header appears on desktop screens.

LocalSettings.php
php
$wgCitizenHeaderPosition = 'left';

Values: 'left', 'right', 'top', 'bottom'

$wgCitizenThemeDefault ​

Sets the default color theme for new visitors.

LocalSettings.php
php
$wgCitizenThemeDefault = 'auto';

Values:

  • 'auto': Matches the user's system or browser preference
  • 'light': Always starts in light mode
  • 'dark': Always starts in dark mode

$wgCitizenEnableCollapsibleSections ​

Allows users to collapse and expand sections on pages, making long articles easier to navigate.

LocalSettings.php
php
$wgCitizenEnableCollapsibleSections = true;

Values: true, false

$wgCitizenShowPageTools ​

Controls who can see the page tools menu (edit, history, etc.).

LocalSettings.php
php
$wgCitizenShowPageTools = true;

Values:

  • true: Always visible to everyone
  • 'login': Visible only to logged-in users
  • 'permission': Visible only to users with specific permissions

$wgCitizenGlobalToolsPortlet ​

The ID of the menu where global tools (like user preferences) should appear. Leave this empty to use the default location.

LocalSettings.php
php
$wgCitizenGlobalToolsPortlet = '';

$wgCitizenEnableDrawerSiteStats ​

Shows site statistics, such as the total page count, at the header of the side drawer menu.

LocalSettings.php
php
$wgCitizenEnableDrawerSiteStats = true;

Values: true, false

$wgCitizenUseNumberFormatter ​

Formats numbers in site statistics according to the wiki's language rules (e.g., using commas or dots as separators).

LocalSettings.php
php
$wgCitizenUseNumberFormatter = true;

Values: true, false

$wgCitizenThemeColor ​

Sets the color of the browser address bar on mobile devices to match your brand.

LocalSettings.php
php
$wgCitizenThemeColor = '#0d0e12';

Values: Hex color code

$wgCitizenEnableARFonts ​

Loads the "Noto Naskh Arabic" font, improving readability for wikis that use Arabic script.

LocalSettings.php
php
$wgCitizenEnableARFonts = false;

Values: true, false

$wgCitizenEnableCJKFonts ​

Loads the "Noto Sans CJK" font, improving readability for wikis that use Chinese, Japanese, or Korean characters.

LocalSettings.php
php
$wgCitizenEnableCJKFonts = false;

Values: true, false

$wgCitizenEnablePreferences ​

Enables the user preferences menu, allowing visitors to customize their reading experience (e.g., font size, width).

LocalSettings.php
php
$wgCitizenEnablePreferences = true;

Values: true, false

$wgCitizenOverflowInheritedClasses ​

A list of CSS classes that should be preserved when tables or images are wrapped in a scrollable container.

LocalSettings.php
php
$wgCitizenOverflowInheritedClasses = [ 'floatleft', 'floatright' ];

$wgCitizenOverflowNowrapClasses ​

A list of CSS classes that prevent an element from being wrapped in a scrollable container. Use this for elements that should always display fully.

LocalSettings.php
php
$wgCitizenOverflowNowrapClasses = [
    'noresize',
    'citizen-table-nowrap',
    'cargoDynamicTable',
    'dataTable',
    'smw-datatable',
    'srf-datatable'
];

$wgCitizenTableOfContentsCollapseAtCount ​

The minimum number of headings required before the sticky table of contents automatically collapses its sub-sections to save space.

LocalSettings.php
php
$wgCitizenTableOfContentsCollapseAtCount = 28;

Command palette ​

$wgCitizenEnableCommandPalette ​

Enables the modern command palette (search bar). If disabled, the wiki will fall back to the standard MediaWiki search module.

LocalSettings.php
php
$wgCitizenEnableCommandPalette = true;

Values: true, false

Search suggestions ​

Deprecated

The old search module is soft-deprecated. Please use the command palette instead.

$wgCitizenSearchModule ​

Selects which search module powers the search suggestions.

LocalSettings.php
php
$wgCitizenSearchModule = 'skins.citizen.search';

Values: 'skins.citizen.search', 'mediawiki.searchSuggest', other ResourceLoader module names

$wgCitizenSearchGateway ​

Selects the API method used to fetch search results. 'mwRestApi' is generally faster and recommended.

LocalSettings.php
php
$wgCitizenSearchGateway = 'mwRestApi';

Values: 'mwActionApi', 'mwRestApi', 'smwAskApi'

$wgCitizenSearchDescriptionSource ​

Determines where the short description text in search results comes from (only applies if using 'mwActionApi').

LocalSettings.php
php
$wgCitizenSearchDescriptionSource = 'textextracts';

$wgCitizenMaxSearchResults ​

The maximum number of search suggestions to display at once.

LocalSettings.php
php
$wgCitizenMaxSearchResults = 10;

Webapp manifest ​

$wgCitizenEnableManifest ​

Enables the web app manifest, allowing users to install your wiki as a standalone app on their device.

LocalSettings.php
php
$wgCitizenEnableManifest = true;

Values: true, false

$wgCitizenManifestOptions ​

Customizes the web app manifest settings, such as the app name, colors, and icons.

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