YaLTeR/niri
1
1
Fork 0
mirror of https://github.com/YaLTeR/niri.git synced 2024-09-20 08:47:22 +03:00
Code Issues Packages Projects Releases Wiki Activity

wiki: Add configuration overview

Browse Source
This commit is contained in:
Ivan Molodetskikh 2024-03-25 21:50:21 +04:00
parent cf54f75113
commit 0b6d62f65e
2 changed files with 39 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
wiki/Configuration:-Overview.md Normal file
View File

@ -0,0 +1,34 @@
### Loading
Niri will load configuration from `$XDG_CONFIG_HOME/.config/niri/config.kdl` or `~/.config/niri/config.kdl`.
If that file is missing, niri will create it with the contents of [the default configuration file](../resources/default-config.kdl).
Please use the default configuration file as the starting point for your custom configuration.
The configuration is live-reloaded.
Simply edit and save the config file, and your changes will be applied.
This includes key bindings, output settings like mode, window rules, and everything else.
You can run `niri validate` to parse the config and see any errors.
To use a different config file path, pass it in the `--config` or `-c` argument to `niri`.
### Syntax
The config is written in [KDL].
Lines starting with `//` are comments; they are ignored.
Also, you can put `/-` in front of a node to comment out the entire node:
```
/-output "eDP-1" {
everything inside here
is ignored
}
```
### Defaults
Omitting most of the sections of the config file will leave you with the default values for that section.
A notable exception is `binds {}`: they do not get filled with defaults, so make sure you do not erase this section.
[KDL]: https://kdl.dev/

6
wiki/_Sidebar.md
View File

@ -5,6 +5,10 @@
* [VSCode, Chromium, WezTerm](https://github.com/YaLTeR/niri/wiki/Application-Issues)
* [Xwayland](https://github.com/YaLTeR/niri/wiki/Xwayland)
## Configuration
* [Overview](https://github.com/YaLTeR/niri/wiki/Configuration:-Overview.md)
* [Input](https://github.com/YaLTeR/niri/wiki/Configuration:-Input.md)
## Development
* [Design Principles](https://github.com/YaLTeR/niri/wiki/Design-Principles)
* [Developing niri](https://github.com/YaLTeR/niri/wiki/Developing-niri)
* [Developing niri](https://github.com/YaLTeR/niri/wiki/Developing-niri)