aboutsummaryrefslogtreecommitdiff
path: root/wiki/Overview.md
diff options
context:
space:
mode:
authorKent Daleng <lolexplode@gmail.com>2025-08-17 16:05:41 +0200
committerGitHub <noreply@github.com>2025-08-17 17:05:41 +0300
commitdc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a (patch)
treea2f2938a7df17c196be7016dc5fe1fc9f75fb484 /wiki/Overview.md
parenta6febb86aa5af0df7bf2792ca027ef95a503d599 (diff)
downloadniri-dc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a.tar.gz
niri-dc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a.tar.bz2
niri-dc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a.zip
github wiki replacement / mkdocs-docs (#2147)
* Add wiki based on mkdocs * wording fixes * fix github bg color on narrow * Fix left sidebar section headers being bigger than pages * fix hover accent * fix list rendering on fractional layout * fix videos * fix automatic full links * remove redundant commented css * improve dark mode contrast * update pygments for better child node coloring * update logo * remove blank lines * add systemd language hint --------- Co-authored-by: Ivan Molodetskikh <yalterz@gmail.com>
Diffstat (limited to 'wiki/Overview.md')
-rw-r--r--wiki/Overview.md104
1 files changed, 0 insertions, 104 deletions
diff --git a/wiki/Overview.md b/wiki/Overview.md
deleted file mode 100644
index 770929fc..00000000
--- a/wiki/Overview.md
+++ /dev/null
@@ -1,104 +0,0 @@
-### Overview
-
-<sup>Since: 25.05</sup>
-
-The Overview is a zoomed-out view of your workspaces and windows.
-It lets you see what's going on at a glance, navigate, and drag windows around.
-
-https://github.com/user-attachments/assets/379a5d1f-acdb-4c11-b36c-e85fd91f0995
-
-Open it with the `toggle-overview` bind, via the top-left hot corner, or using a touchpad four-finger swipe up.
-While in the overview, all keyboard shortcuts keep working, while pointing devices get easier:
-
-- Mouse: left click and drag windows to move them, right click and drag to scroll workspaces left/right, scroll to switch workspaces (no holding Mod required).
-- Touchpad: two-finger scrolling that matches the normal three-finger gestures.
-- Touchscreen: one-finger scrolling, or one-finger long press to move a window.
-
-> [!TIP]
-> The overview needs to draw a background under every workspace.
-> So, layer-shell surfaces work this way: the *background* and *bottom* layers zoom out together with the workspaces, while the *top* and *overlay* layers remain on top of the overview.
->
-> Put your bar on the *top* layer.
-
-Drag-and-drop will scroll the workspaces up/down in the overview, and will activate a workspace when holding it for a moment.
-Combined with the hot corner, this lets you do a mouse-only DnD across workspaces.
-
-https://github.com/user-attachments/assets/5f09c5b7-ff40-462b-8b9c-f1b8073a2cbb
-
-You can also drag-and-drop a window to a new workspace above, below, or between existing workspaces.
-
-https://github.com/user-attachments/assets/b76d5349-aa20-4889-ab90-0a51554c789d
-
-### Configuration
-
-See the full documentation for the `overview {}` section [here](./Configuration:-Miscellaneous.md#overview).
-
-You can set the zoom-out level like this:
-
-```kdl
-// Make workspaces four times smaller than normal in the overview.
-overview {
- zoom 0.25
-}
-```
-
-To change the color behind the workspaces, use the `backdrop-color` setting:
-
-```kdl
-// Make the backdrop light.
-overview {
- backdrop-color "#777777"
-}
-```
-
-You can also disable the hot corner:
-
-```kdl
-// Disable the hot corners.
-gestures {
- hot-corners {
- off
- }
-}
-```
-
-### Backdrop customization
-
-Apart from setting a custom backdrop color like described above, you can also put a layer-shell wallpaper into the backdrop with a [layer rule](./Configuration:-Layer-Rules.md#place-within-backdrop), for example:
-
-```kdl
-// Put swaybg inside the overview backdrop.
-layer-rule {
- match namespace="^wallpaper$"
- place-within-backdrop true
-}
-```
-
-This will only work for *background* layer surfaces that ignore exclusive zones (typical for wallpaper tools).
-
-You can run two different wallpaper tools (like swaybg and swww), one for the backdrop and one for the normal workspace background.
-This way you could set the backdrop one to a blurred version of the wallpaper for a nice effect.
-
-You can also combine this with a transparent background color if you don't like the wallpaper moving together with workspaces:
-
-```kdl
-// Make the wallpaper stationary, rather than moving with workspaces.
-layer-rule {
- // This is for swaybg; change for other wallpaper tools.
- // Find the right namespace by running niri msg layers.
- match namespace="^wallpaper$"
- place-within-backdrop true
-}
-
-// Set transparent workspace background color.
-layout {
- background-color "transparent"
-}
-
-// Optionally, disable the workspace shadows in the overview.
-overview {
- workspace-shadow {
- off
- }
-}
-```