mediawiki-skins-Citizen/README.md

19 lines
1.5 KiB
Markdown
Raw Normal View History

2019-12-21 05:56:15 +00:00
# Citizen
2019-12-26 08:13:43 +00:00
![](https://github.com/StarCitizenTools/mediawiki-skins-Citizen/workflows/Composer/badge.svg) ![](https://github.com/StarCitizenTools/mediawiki-skins-Citizen/workflows/Grunt/badge.svg)
2019-12-26 06:40:39 +00:00
2019-12-21 06:03:27 +00:00
Citizen is a responsive skin for [MediaWiki](https://www.mediawiki.org) built by the [Star Citizen Wiki](https://starcitizen.tools) 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 feel free to submit a pull request or bug report if you find a bug!
2019-12-21 05:56:15 +00:00
## 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. 📱
2019-12-24 06:08:43 +00:00
* **HTTP security response headers**: Enhance the security of your wiki from HTTP response headers. 🔒🔑
2019-12-21 05:56:15 +00:00
## Configurations
This section is still WIP. Please refer to the skin.json for more instructions!
## Requirements
* [MediaWiki](https://www.mediawiki.org) 1.31 or later