MKDoc website (#1772)

* Add initial documentation page using mkdocs

* Test action

* Add notes to mkdoc site.

* Add installation guide

* Add installation and config guide to mkdocs.

* Add installation manual

* Add image to main page

* [mkdocs] Add plugin guide.

* [mkdocs] Add plugin to main page and some small fixes.

* Add shipped themes page

* [actions] Also rebuild website on the next branch

91 files changed, 18747 insertions, 102 deletions

diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
new file mode 100644
index 00000000..4137d29a
--- /dev/null
+++ b/.github/workflows/mkdocs.yml
@@ -0,0 +1,20 @@
+name: Publish docs via GitHub Pages
+on:
+  push:
+    branches:
+      - sphinx
+      - next
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v1
+
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          CONFIG_FILE: mkdocs/mkdocs.yml 
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CONFIG.md b/CONFIG.md
index 8732b12c..f065cb86 100644
--- a/CONFIG.md
+++ b/CONFIG.md
@@ -1,22 +1,8 @@
->  # :warning: This page does not describe all of **ROFI**'s configuration options, just the most common usecase. For the full configuration options, check the manpages.
+>  This page does not describe all of **ROFI**'s configuration options, just the most common usecase. For the full configuration options, check the manpages.
 
 <br />
 
  
-## :exclamation: Upgrade from old configuration format to new :exclamation:
-
-In release after '2 Jan 2020' you can convert to the new configuration format by using the following command:
-
-```bash 
-rofi -upgrade-config
-```
-
-This will create `~/.config/rofi/config.rasi` (or the default location for your system) with the previously configured options.
-
-From 1.7.0 the old configuration format is no longer supported and the `-upgrade-config` option is no longer available.
-
-<br />
-
 # Where does the configuration live
 
 Rofi's configurations, custom themes live in `${XDG_CONFIG_HOME}/rofi/`, on most systems this is `~/.config/rofi/`.
@@ -62,6 +48,12 @@ configuration {
 }
 ```
 
+To create a copy of the current theme, you can run:
+
+```bash
+rofi -dump-theme > ~/.config/rofi/current.rasi
+```
+
 # Configuration file format
 
 ## Encoding
@@ -195,6 +187,7 @@ configuration {
 
 ```
 
-Rofi will first parse the config block in `~/.config/rofi/config.rasi`, then parse `~/.config/rofi/myConfig.rasi` and then load the theme `myTheme`.\
-More information can be obtained from **Themes** section\
-Imports can be nested.
+Rofi will first parse the config block in `~/.config/rofi/config.rasi`, then
+parse `~/.config/rofi/myConfig.rasi` and then load the theme `myTheme`.  More
+information can be obtained from the **rofi-theme(5)** manpage.  Imports can be
+nested.
diff --git a/INSTALL.md b/INSTALL.md
index aff74e02..4e305095 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -184,6 +184,8 @@ can then load the core in GDB.
 > Where the core file is located and what its exact name is different on each distributions. Please consult the
 > relevant documentation.
 
+For more information see the rofi-debugging(5) manpage.
+
 ## Install distribution
 
 ### Debian or Ubuntu
diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5
index b7b64b25..080c0854 100644
--- a/doc/rofi-theme.5
+++ b/doc/rofi-theme.5
@@ -4,7 +4,7 @@
 .PP
 \fBrofi-theme\fP - Rofi theme format files
 
-.SH GETTING STARTED WITH THEMING
+.SH Getting started with theming
 .PP
 The easiest way to get started theming rofi is by modifying your existing theme.
 
@@ -227,7 +227,7 @@ rofi -dump-theme
 .fi
 .RE
 
-.SH DEFAULT THEME LOADING
+.SH Default theme loading
 .PP
 By default, rofi loads the default theme. This theme is \fBalways\fP loaded.
 The default configuration contains:
@@ -265,14 +265,14 @@ rofi -no-config -dump-theme
 .fi
 .RE
 
-.SH DESCRIPTION
+.SH Description
 .PP
 The need for a new theme format was motivated by the fact that the way rofi handled widgets has changed. From a very
 static drawing of lines and text to a nice structured form of packing widgets. This change made it possible to provide a
 more flexible theme framework. The old theme format and config file are not flexible enough to expose these options in a
 user-friendly way. Therefore, a new file format has been created, replacing the old one.
 
-.SH FORMAT SPECIFICATION
+.SH Format specification
 .SH Encoding
 .PP
 The encoding of the file is UTF-8. Both unix (\fB\fC\\n\fR) and windows (\fB\fC\\r\\n\fR) newlines format are supported. But unix is
@@ -556,7 +556,7 @@ Inherit
 .PP
 Some of these types are a combination of other types.
 
-.SH String
+.SS String
 .RS
 .IP \(bu 2
 Format:  \fB\fC"[:print:]+"\fR
@@ -595,7 +595,7 @@ text {
 .PP
 The following special characters can be escaped: \fB\fC\\b\fR, \fB\fC\\f\fR, \fB\fC\\n\fR, \fB\fC\\r\fR, \fB\fC\\t\fR, \fB\fC\\v\fR, \fB\fC\\\fR and \fB\fC"\fR\&.
 
-.SH Integer
+.SS Integer
 .RS
 .IP \(bu 2
 Format: \fB\fC[-+]?[:digit:]+\fR
@@ -617,7 +617,7 @@ lines: 12;
 .fi
 .RE
 
-.SH Real
+.SS Real
 .RS
 .IP \(bu 2
 Format: \fB\fC[-+]?[:digit:]+(\\.[:digit:]+)?\fR
@@ -642,7 +642,7 @@ real: 3.4;
 .PP
 The following is not valid: \fB\fC\&.3\fR, \fB\fC3.\fR or scientific notation: \fB\fC3.4e-3\fR\&.
 
-.SH Boolean
+.SS Boolean
 .RS
 .IP \(bu 2
 Format: \fB\fC(true|false)\fR
@@ -664,7 +664,7 @@ dynamic: false;
 .fi
 .RE
 
-.SH Image
+.SS Image
 .PP
 \fBrofi\fP support a limited set of background-image formats.
 
@@ -688,7 +688,7 @@ Angle in deg,rad,grad (as used in color).
 .PP
 Where the \fB\fCpath\fR is a string, and \fB\fCstop\fR color is of type color.
 
-.SH Color
+.SS Color
 .PP
 \fBrofi\fP supports the color formats as specified in the CSS standard (1,2,3 and some of CSS 4)
 
@@ -776,7 +776,7 @@ text-color: Black;
 .fi
 .RE
 
-.SH Text style
+.SS Text style
 .RS
 .IP \(bu 2
 Format: \fB\fC(bold|italic|underline|strikethrough|none)\fR
@@ -820,7 +820,7 @@ The following option is disabled as pango crashes on this if there is eel
 
 .RE
 
-.SH Line style
+.SS Line style
 .RS
 .IP \(bu 2
 Format: \fB\fC(dash|solid)\fR
@@ -833,7 +833,7 @@ It currently supports:
  * \fB\fCdash\fR:  a dashed line, where the gap is the same width as the dash
  * \fB\fCsolid\fR: a solid line
 
-.SH Distance
+.SS Distance
 .RS
 .IP \(bu 2
 Format: \fB\fC{Integer}px\fR
@@ -935,7 +935,7 @@ It supports the following operations:
 .PP
 It uses the C precedence ordering.
 
-.SH Padding
+.SS Padding
 .RS
 .IP \(bu 2
 Format: \fB\fC{Integer}\fR
@@ -968,7 +968,7 @@ The different number of fields in the formats are parsed like:
 
 .RE
 
-.SH Border
+.SS Border
 .RS
 .IP \(bu 2
 Format: \fB\fC{Integer}\fR
@@ -1003,7 +1003,7 @@ When no unit is specified, pixels are assumed.
 
 .RE
 
-.SH Position
+.SS Position
 .PP
 Indicate a place on the window/monitor.
 
@@ -1028,7 +1028,7 @@ Format: \fB\fC(center|east|north|west|south|north east|north west|south west|sou
 
 .RE
 
-.SH Visibility
+.SS Visibility
 .PP
 It is possible to hide widgets:
 
@@ -1043,7 +1043,7 @@ inputbar {
 .fi
 .RE
 
-.SH Reference
+.SS Reference
 .RS
 .IP \(bu 2
 Format: \fB\fC@{PROPERTY NAME}\fR
@@ -1110,7 +1110,7 @@ window {
 If the property \fB\fCwidth\fR is set globally (\fB\fC*{}\fR) that value is used, if the property
 \fB\fCwidth\fR is not set, the default value is used.
 
-.SH Orientation
+.SS Orientation
 .RS
 .IP \(bu 2
 Format: \fB\fC(horizontal|vertical)\fR
@@ -1120,7 +1120,7 @@ Format: \fB\fC(horizontal|vertical)\fR
 .PP
 Specify the orientation of the widget.
 
-.SH Cursor
+.SS Cursor
 .RS
 .IP \(bu 2
 Format: \fB\fC(default|pointer|text)\fR
@@ -1130,7 +1130,7 @@ Format: \fB\fC(default|pointer|text)\fR
 .PP
 Specify the type of mouse cursor that is set when the mouse pointer is over the widget.
 
-.SH List of keywords
+.SS List of keywords
 .RS
 .IP \(bu 2
 Format: \fB\fC[ keyword, keyword ]\fR
@@ -1141,7 +1141,7 @@ Format: \fB\fC[ keyword, keyword ]\fR
 A list starts with a '[' and ends with a ']'. The entries in the list are comma-separated.
 The \fB\fCkeyword\fR in the list refers to an widget name.
 
-.SH List of values
+.SS List of values
 .RS
 .IP \(bu 2
 Format: \fB\fC[ value, value, ... ]\fR
@@ -1151,7 +1151,7 @@ Format: \fB\fC[ value, value, ... ]\fR
 .PP
 An list starts with a '[' and ends with a ']'. The entries in the list are comma-separated.
 
-.SH Environment variable
+.SS Environment variable
 .RS
 .IP \(bu 2
 Format: \fB\fC${:alnum:}\fR
@@ -1198,7 +1198,7 @@ window {
 .PP
 If environment WIDTH is set, then that value is parsed, otherwise the default value (\fB\fC40%\fR).
 
-.SH Inherit
+.SS Inherit
 .RS
 .IP \(bu 2
 Format: \fB\fCinherit\fR
@@ -1219,7 +1219,7 @@ mainbox {
 .fi
 .RE
 
-.SH ELEMENTS PATHS
+.SH Elements paths
 .PP
 Element paths exists of two parts, the first part refers to the actual widget by name.
 Some widgets have an extra state.
@@ -1257,10 +1257,10 @@ element selected {
 .fi
 .RE
 
-.SH SUPPORTED ELEMENT PATH
-.SH Name
+.SS Supported element paths
+.SS Name
 .PP
-The current widgets available in \fBrofi\fP:
+The default widgets available in \fBrofi\fP and the default hierarchic:
 </