summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Davenport <DaveDavenport@users.noreply.github.com>2022-12-31 13:15:01 +0100
committerGitHub <noreply@github.com>2022-12-31 13:15:01 +0100
commit3d62bb32c93365729c2db11bc81be46c050fabaf (patch)
treeb3e594d6017e6172897b37b0ee6c2de0620370aa
parent9143d291d42dde35eebc8777a18e52d4a77f7a48 (diff)
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
-rw-r--r--.github/workflows/mkdocs.yml20
-rw-r--r--CONFIG.md29
-rw-r--r--INSTALL.md2
-rw-r--r--doc/rofi-theme.578
-rw-r--r--doc/rofi-theme.5.markdown86
-rw-r--r--doc/rofi.110
-rw-r--r--doc/rofi.1.markdown1
-rw-r--r--mkdocs/docs/1.7.0/rofi-script.5.markdown145
-rw-r--r--mkdocs/docs/1.7.0/rofi-theme.5.markdown1140
-rw-r--r--mkdocs/docs/1.7.0/rofi.1.markdown1086
-rw-r--r--mkdocs/docs/1.7.1/rofi-script.5.markdown145
-rw-r--r--mkdocs/docs/1.7.1/rofi-theme.5.markdown1198
-rw-r--r--mkdocs/docs/1.7.1/rofi.1.markdown1116
-rw-r--r--mkdocs/docs/1.7.2/rofi-script.5.markdown145
-rw-r--r--mkdocs/docs/1.7.2/rofi-theme.5.markdown1198
-rw-r--r--mkdocs/docs/1.7.2/rofi.1.markdown1116
-rw-r--r--mkdocs/docs/1.7.3/rofi-debugging.5.markdown176
-rw-r--r--mkdocs/docs/1.7.3/rofi-dmenu.5.markdown227
-rw-r--r--mkdocs/docs/1.7.3/rofi-keys.5.markdown471
-rw-r--r--mkdocs/docs/1.7.3/rofi-script.5.markdown155
-rw-r--r--mkdocs/docs/1.7.3/rofi-theme.5.markdown1443
-rw-r--r--mkdocs/docs/1.7.3/rofi.1.markdown1030
-rw-r--r--mkdocs/docs/1.7.4/rofi-debugging.5.markdown176
-rw-r--r--mkdocs/docs/1.7.4/rofi-dmenu.5.markdown217
-rw-r--r--mkdocs/docs/1.7.4/rofi-keys.5.markdown456
-rw-r--r--mkdocs/docs/1.7.4/rofi-script.5.markdown155
-rw-r--r--mkdocs/docs/1.7.4/rofi-theme.5.markdown1421
-rw-r--r--mkdocs/docs/1.7.4/rofi.1.markdown1005
-rw-r--r--mkdocs/docs/1.7.5/rofi-debugging.5.markdown176
-rw-r--r--mkdocs/docs/1.7.5/rofi-dmenu.5.markdown217
-rw-r--r--mkdocs/docs/1.7.5/rofi-keys.5.markdown456
-rw-r--r--mkdocs/docs/1.7.5/rofi-script.5.markdown155
-rw-r--r--mkdocs/docs/1.7.5/rofi-theme.5.markdown1421
-rw-r--r--mkdocs/docs/1.7.5/rofi.1.markdown1005
l---------mkdocs/docs/CONFIG.md1
l---------mkdocs/docs/COPYING.md1
l---------mkdocs/docs/INSTALL.md1
l---------mkdocs/docs/current/rofi-debugging.5.markdown1
l---------mkdocs/docs/current/rofi-dmenu.5.markdown1
l---------mkdocs/docs/current/rofi-keys.5.markdown1
l---------mkdocs/docs/current/rofi-script.5.markdown1
l---------mkdocs/docs/current/rofi-theme.5.markdown1
l---------mkdocs/docs/current/rofi.1.markdown1
-rw-r--r--mkdocs/docs/guides/Plugins/2017-04-19-rofi-140-sneak-preview-plugins.md695
-rw-r--r--mkdocs/docs/guides/Plugins/rofi-file-browser.pngbin0 -> 18170 bytes
-rw-r--r--mkdocs/docs/guides/Positioning/anchors.svg (renamed from doc/Notes/Theme/Positioning/anchors.svg)0
-rw-r--r--mkdocs/docs/guides/Positioning/example-pos.png (renamed from doc/Notes/Theme/Positioning/example-pos.png)bin535217 -> 535217 bytes
-rw-r--r--mkdocs/docs/guides/Positioning/theme3-positioning.markdown (renamed from doc/Notes/Theme/Positioning/theme3-positioning.markdown)0
-rw-r--r--mkdocs/docs/guides/Transparency/rofi-background.png (renamed from doc/Notes/Theme/Transparency/rofi-background.png)bin1572714 -> 1572714 bytes
-rw-r--r--mkdocs/docs/guides/Transparency/rofi-background2.png (renamed from doc/Notes/Theme/Transparency/rofi-background2.png)bin782595 -> 782595 bytes
-rw-r--r--mkdocs/docs/guides/Transparency/rofi-fake.png (renamed from doc/Notes/Theme/Transparency/rofi-fake.png)bin140385 -> 140385 bytes
-rw-r--r--mkdocs/docs/guides/Transparency/rofi-paper.png (renamed from doc/Notes/Theme/Transparency/rofi-paper.png)bin27304 -> 27304 bytes
-rw-r--r--mkdocs/docs/guides/Transparency/rofi-real.png (renamed from doc/Notes/Theme/Transparency/rofi-real.png)bin46680 -> 46680 bytes
-rw-r--r--mkdocs/docs/guides/Transparency/rofi-transp.png (renamed from doc/Notes/Theme/Transparency/rofi-transp.png)bin10940 -> 10940 bytes
-rw-r--r--mkdocs/docs/guides/Transparency/structure.svg (renamed from doc/Notes/Theme/Transparency/structure.svg)0
-rw-r--r--mkdocs/docs/guides/Transparency/theme3-transparency.markdown (renamed from doc/Notes/Theme/Transparency/theme3-transparency.markdown)0
-rw-r--r--mkdocs/docs/images/rofi.pngbin0 -> 58343 bytes
-rw-r--r--mkdocs/docs/index.md35
-rw-r--r--mkdocs/docs/themes/Adapta-Nokto.pngbin0 -> 21676 bytes
-rw-r--r--mkdocs/docs/themes/Arc-Dark.pngbin0 -> 25511 bytes
-rw-r--r--mkdocs/docs/themes/Arc.pngbin0 -> 21723 bytes
-rw-r--r--mkdocs/docs/themes/DarkBlue.pngbin0 -> 26540 bytes
-rw-r--r--mkdocs/docs/themes/Indego.pngbin0 -> 21950 bytes
-rw-r--r--mkdocs/docs/themes/Monokai.pngbin0 -> 25897 bytes
-rw-r--r--mkdocs/docs/themes/Paper.pngbin0 -> 21850 bytes
-rw-r--r--mkdocs/docs/themes/android_notification.pngbin0 -> 21541 bytes
-rw-r--r--mkdocs/docs/themes/arthur.pngbin0 -> 24043 bytes
-rw-r--r--mkdocs/docs/themes/blue.pngbin0 -> 23114 bytes
-rw-r--r--mkdocs/docs/themes/c64.pngbin0 -> 17303 bytes
-rwxr-xr-xmkdocs/docs/themes/capture.sh51
-rw-r--r--mkdocs/docs/themes/default.pngbin0 -> 24975 bytes
-rw-r--r--mkdocs/docs/themes/dmenu.pngbin0 -> 11040 bytes
-rw-r--r--mkdocs/docs/themes/docu.pngbin0 -> 129092 bytes
-rw-r--r--mkdocs/docs/themes/fancy.pngbin0 -> 33331 bytes
-rw-r--r--mkdocs/docs/themes/glue_pro_blue.pngbin0 -> 25458 bytes
-rw-r--r--mkdocs/docs/themes/gruvbox-dark-hard.pngbin0 -> 21816 bytes
-rw-r--r--mkdocs/docs/themes/gruvbox-dark-soft.pngbin0 -> 21970 bytes
-rw-r--r--mkdocs/docs/themes/gruvbox-dark.pngbin0 -> 21926 bytes
-rw-r--r--mkdocs/docs/themes/gruvbox-light-hard.pngbin0 -> 22171 bytes
-rw-r--r--mkdocs/docs/themes/gruvbox-light-soft.pngbin0 -> 22061 bytes
-rw-r--r--mkdocs/docs/themes/gruvbox-light.pngbin0 -> 22129 bytes
-rw-r--r--mkdocs/docs/themes/iggy.pngbin0 -> 1078652 bytes
-rw-r--r--mkdocs/docs/themes/lb.pngbin0 -> 25160 bytes
-rw-r--r--mkdocs/docs/themes/paper-float.pngbin0 -> 25555 bytes
-rw-r--r--mkdocs/docs/themes/purple.pngbin0 -> 21645 bytes
-rw-r--r--mkdocs/docs/themes/sidebar-v2.pngbin0 -> 47820 bytes
-rw-r--r--mkdocs/docs/themes/sidebar.pngbin0 -> 28047 bytes
-rw-r--r--mkdocs/docs/themes/solarized.pngbin0 -> 21140 bytes
-rw-r--r--mkdocs/docs/themes/solarized_alternate.pngbin0 -> 21274 bytes
-rw-r--r--mkdocs/docs/themes/themes.md123
-rw-r--r--mkdocs/mkdocs.yml59
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:
.RS
.IP \(bu 2
@@ -1338,7 +1338,7 @@ The current widgets available in \fBrofi\fP:
Note that these path names match the default theme. Themes that provide a custom layout will have different
elements, and structure.
-.SH State
+.SS State
.PP
State: State of widget
@@ -1401,11 +1401,11 @@ Note that a state modifies the original element, it therefore contains all the p
The scrollbar uses the \fB\fChandle\fR state when drawing the small scrollbar handle.
This allows the colors used for drawing the handle to be set independently.
-.SH SUPPORTED PROPERTIES
+.SH Widget properties
.PP
The following properties are currently supported:
-.SS all widgets:
+.SS all widgets
.RS
.IP \(bu 2
\fBenabled\fP: enable/disable rendering of the widget
@@ -1436,7 +1436,7 @@ Type of mouse cursor that is set when the mouse pointer is hovered over the widg
.RE
-.SS window:
+.SS window
.RS
.IP \(bu 2
\fBfont\fP: string
@@ -1468,7 +1468,7 @@ The offset of the window to the anchor point, allowing you to push the window le
.RE
-.SS scrollbar:
+.SS scrollbar
.RS
.IP \(bu 2
\fBbackground-color\fP: color
@@ -1481,7 +1481,7 @@ The offset of the window to the anchor point, allowing you to push the window le
.RE
-.SS box:
+.SS box
.RS
.IP \(bu 2
\fBorientation\fP: orientation
@@ -1492,7 +1492,7 @@ The offset of the window to the anchor point, allowing you to push the window le
.RE
-.SS textbox:
+.SS textbox
.RS
.IP \(bu 2
\fBbackground-color\fP: color
@@ -1552,7 +1552,7 @@ The text appears to the right of the tab stop position (other alignments are not
.RE
-.SS listview:
+.SS listview
.RS
.IP \(bu 2
\fBcolumns\fP: integer
@@ -1600,7 +1600,7 @@ hitting accept will activate the first entry.
.PP
Each element is a \fB\fCbox\fR called \fB\fCelement\fR\&. Each \fB\fCelement\fR can contain an \fB\fCelement-icon\fR and \fB\fCelement-text\fR\&.
-.SS listview text highlight:
+.SS listview text highlight
.PP
The \fB\fCelement-text\fR widget in the \fB\fClistview\fR is the one used to show the text.
On this widget set the \fB\fChighlight\fR property (only place this property is used) to change
@@ -2009,7 +2009,7 @@ If both dummy widgets are set to expand, \fB\fCchild\fR will be centered. Depend
remaining space will be equally divided between both dummy and child widget (expand enabled), or both dummy widgets
(expand disabled).
-.SH DEBUGGING
+.SH Debugging
.PP
To get debug information from the parser, run rofi like:
@@ -2259,7 +2259,7 @@ If a filename is provided, it will try to resolve it in the following order:
.PP
A name is resolved as a filename by appending the \fB\fC\&.rasi\fR extension.
-.SH EXAMPLES
+.SH Examples
.PP
Several examples are installed together with \fBrofi\fP\&. These can be found in \fB\fC{datadir}/rofi/themes/\fR, where
\fB\fC{datadir}\fR is the install path of \fBrofi\fP data. When installed using a package manager, this is usually: \fB\fC/usr/share/\fR\&.
diff --git a/doc/rofi-theme.5.markdown b/doc/rofi-them