StarCitizenTools/mediawiki-skins-Citizen
1
0
Fork 0
mirror of https://github.com/StarCitizenTools/mediawiki-skins-Citizen.git synced 2024-11-27 15:50:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation to the skin

Browse source
This commit is contained in:
alistair3149 2019-12-21 00:56:15 -05:00
parent 9db38659b3
commit f3e57a19fc
3 changed files with 16 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CODE_OF_CONDUCT.md Normal file
View file

@ -0,0 +1 @@
The development of this software is covered by a [Code of Conduct](https://www.mediawiki.org/wiki/Code_of_Conduct).

15
README.md Normal file
View file

@ -0,0 +1,15 @@
# Citizen
Citizen is a responsive skin for [MediaWiki](https://www.mediawiki.org) built by the [Star Citizen Wiki](https://starcitizen.tools) team. Although it is 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 constraint, we are currently not taking any support requests unless it is relvant to our installation, but feel free to submit pull requests if you find a bug!
## 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. 📱
## 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

18
skin.json
View file

@ -13,24 +13,6 @@
},
"config_prefix": "wgCitizen",
"config": {
"ButtonLink": {
"value": "",
"description": "The link of the floating action button",
"descriptionmsg": "citizen-config-buttonlink",
"public": true
},
"ButtonLabel": {
"value": "",
"description": "The label of the floating action button",
"descriptionmsg": "citizen-config-buttonlabel",
"public": true
},
"ButtonTitle": {
"value": "",
"description": "The title in the link element of the floating action button",
"descriptionmsg": "citizen-config-buttontitle",
"public": true
},
"ThemeColor": {
"value": "#11151d",
"description": "The theme color defined in the meta tag",