From f3e57a19fc2d8068a143b575f45fe7e954f7b726 Mon Sep 17 00:00:00 2001 From: alistair3149 Date: Sat, 21 Dec 2019 00:56:15 -0500 Subject: [PATCH] Add documentation to the skin --- CODE_OF_CONDUCT.md | 1 + README.md | 15 +++++++++++++++ skin.json | 18 ------------------ 3 files changed, 16 insertions(+), 18 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 README.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..d8e5d087 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1 @@ +The development of this software is covered by a [Code of Conduct](https://www.mediawiki.org/wiki/Code_of_Conduct). diff --git a/README.md b/README.md new file mode 100644 index 00000000..ec04141b --- /dev/null +++ b/README.md @@ -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 diff --git a/skin.json b/skin.json index 9ed8c1f2..e6683cfb 100644 --- a/skin.json +++ b/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",