configuring: add a start page
Some checks are pending
Update Website / notify-parent-repo (push) Waiting to run

This commit is contained in:
Vaxry 2025-05-01 00:10:08 +01:00
parent 60606f3832
commit a6db1a125a
No known key found for this signature in database
GPG key ID: 665806380871D640
2 changed files with 57 additions and 41 deletions

View file

@ -0,0 +1,49 @@
---
weight: 1
title: Start
---
The config is located in `$XDG_CONFIG_HOME/hypr/hyprland.conf`. In most cases,
that maps to `~/.config/hypr/hyprland.conf`.
You can tell Hyprland to use a specific configuration file by using the
`--config` (or `-c`) argument.
Hyprland will automatically generate an example config for you if you don't have
one. You can find an example config
[here](https://github.com/hyprwm/Hyprland/blob/main/example/hyprland.conf).
By removing the line containing `autogenerated=1` you'll remove the yellow
warning.
The config is reloaded the moment you save it. However, you can use
`hyprctl reload` to reload the config manually.
Start a section with `name {` and end in `}` **_in separate lines!_**
{{< callout >}}
The default config is not complete and does not list all the options / features
of Hyprland. Please refer to this wiki page and the pages linked further down
here for full configuration instructions.
**Make sure to read the [Variables](../Variables) page as well**. It covers all
the toggleable / numerical options.
{{< /callout >}}
## Language style and syntax
See the [hyprlang page](../../Hypr-Ecosystem/hyprlang).
## Basic configuring
To configure Hyprland's options, animations, styling, etc. see
[Variables](../Variables).
## Advanced configuring
Some keywords (binds, curves, execs, monitors, etc.) are not variables but
define special behavior.
See all of them in [Keywords](../Keywords) and the sidebar.

View file

@ -5,47 +5,14 @@ sidebar:
open: true open: true
--- ---
The config is located in `$XDG_CONFIG_HOME/hypr/hyprland.conf`. In most cases, This section is all about the configuring (aka ricing) of your Hyprland experience.
that maps to `~/.config/hypr/hyprland.conf`. It links to other pages where necessary, and will walk you through:
You can tell Hyprland to use a specific configuration file by using the - The config file
`--config` (or `-c`) argument. - Every option and function in it
- Extending functionality via scripts
- Some uncommon tips and tricks (e.g. switching layouts, disabling keybinds on-demand, etc)
Hyprland will automatically generate an example config for you if you don't have It also contains some sample configurations you can take inspiration from.
one. You can find an example config
[here](https://github.com/hyprwm/Hyprland/blob/main/example/hyprland.conf).
By removing the line containing `autogenerated=1` you'll remove the yellow Start with [the Start Page](../Start.md).
warning.
The config is reloaded the moment you save it. However, you can use
`hyprctl reload` to reload the config manually.
Start a section with `name {` and end in `}` **_on separate lines!_**
{{< callout >}}
The default config is not complete and does not list all the options / features
of Hyprland. Please refer to this wiki page and the pages linked further down
here for full configuration instructions.
**Make sure to read the [Variables](./Variables) page as well**. It covers all
the toggleable / numerical options.
{{< /callout >}}
## Language style and syntax
See the [hyprlang page](../Hypr-Ecosystem/hyprlang).
## Basic configuring
To configure Hyprland's options, animations, styling, etc. see
[Variables](./Variables).
## Advanced configuring
Some keywords (binds, curves, execs, monitors, etc.) are not variables but
define special behavior.
See all of them in [Keywords](./Keywords) and the sidebar.