mirror of
https://github.com/StarCitizenTools/mediawiki-skins-Citizen.git
synced 2024-11-11 16:48:54 +00:00
Add documentation to the skin
This commit is contained in:
parent
9db38659b3
commit
f3e57a19fc
1
CODE_OF_CONDUCT.md
Normal file
1
CODE_OF_CONDUCT.md
Normal 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
15
README.md
Normal 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
18
skin.json
|
@ -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",
|
||||
|
|
Loading…
Reference in a new issue