Welcome to the niri documentation!
Feel free to look through usage and Getting started. If you're looking for ways to configure niri, check out the introduction to configuration. If you want to contribute to niri, look at the development section and how to develop niri.
If you're not already here, check out our new wiki website! https://yalter.github.io/niri/
The documentation is open to contribution, but please discuss bigger changes in our Matrix room first! The wiki is generated from files in the docs/wiki/ folder of the repository, so you can open a pull request modifying it there.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
Usage
- Getting Started
- Example systemd Setup
- Important Software
- Workspaces
- Floating Windows
- Tabs
- Overview
- Screencasting
- Layer‐Shell Components
- IPC,
niri msg - Application-Specific Issues
- Nvidia
- Xwayland
- Gestures
- Fullscreen and Maximize
- Window Effects
- Packaging niri
- Integrating niri
- Security Model
- Accessibility
- Name and Logo
- FAQ
Configuration
- Introduction
- Input
- Outputs
- Key Bindings
- Switch Events
- Layout
- Named Workspaces
- Miscellaneous
- Window Rules
- Layer Rules
- Animations
- Gestures
- Recent Windows
- Debug Options
- Include