Skip to content

Commit

Permalink
capitalize links
Browse files Browse the repository at this point in the history
  • Loading branch information
fufexan committed Mar 17, 2024
1 parent eb8b70d commit 22d5e48
Show file tree
Hide file tree
Showing 29 changed files with 100 additions and 97 deletions.
8 changes: 4 additions & 4 deletions pages/Configuring/Binds.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ bind=,Print,exec,grim

{{< /callout >}}

_For a complete mod list, see [Variables](../variables/#variable-types)._
_For a complete mod list, see [Variables](../Variables/#variable-types)._

_The dispatcher list can be found in
[Dispatchers](../dispatchers/#list-of-dispatchers)._
[Dispatchers](../Dispatchers/#list-of-dispatchers)._

## Uncommon syms / binding with a keycode

Expand Down Expand Up @@ -218,7 +218,7 @@ bindr=ALT,Alt_L,exec,amongus
Yes, you heard this right, Hyprland does support global keybinds for ALL apps,
including OBS, Discord, Firefox, etc.

See the [`pass` dispatcher](../dispatchers/#list-of-dispatchers) for keybinds.
See the [`pass` dispatcher](../Dispatchers/#list-of-dispatchers) for keybinds.

Let's take OBS as an example: the "Start/Stop Recording" keybind is set to
<key>SUPER</key> + <key>F10</key>, and you want to make it work globally.
Expand Down Expand Up @@ -270,7 +270,7 @@ bind = SUPERSHIFT, A, global, coolApp:myToggle
{{< callout type=info >}}

Please note that this function will _only_ work with
[XDPH](../../hyprland-ecosystem/xdg-desktop-portal-hyprland).
[XDPH](../../Hypr-Ecosystem/xdg-desktop-portal-hyprland).

{{</ callout >}}

Expand Down
6 changes: 3 additions & 3 deletions pages/Configuring/Configuring-Hyprland.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ 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
**Make sure to read the [Variables](../Variables) page as well**. It covers all
the toggleable / numerical options.

{{< /callout >}}
Expand Down Expand Up @@ -60,11 +60,11 @@ If you want to escape it (put an actual `#` and not start a comment) you can use
## Basic configuring

To configure the "options" of Hyprland, animations, styling, etc. see
[Variables](../variables).
[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.
See all of them in [Keywords](../Keywords) and the sidebar.
4 changes: 2 additions & 2 deletions pages/Configuring/Dispatchers.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ layout pages (See the sidebar).
| movegroupwindow | Swaps the active window with the next or previous in a group | `b` for back, anything else for forward |
| denywindowfromgroup | Prohibit the active window from becoming or being inserted into group | `on`, `off` or, `toggle` |
| setignoregrouplock | Temporarily enable or disable binds:ignore_group_lock | `on`, `off`, or `toggle` |
| global | Executes a Global Shortcut using the GlobalShortcuts portal. See [here](../binds/#global-keybinds) | name |
| submap | Change the current mapping group. See [Submaps](../binds/#submaps) | `reset` or name |
| global | Executes a Global Shortcut using the GlobalShortcuts portal. See [here](../Binds/#global-keybinds) | name |
| submap | Change the current mapping group. See [Submaps](../Binds/#submaps) | `reset` or name |

{{< callout type=warning >}}

Expand Down
2 changes: 1 addition & 1 deletion pages/Configuring/Environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,5 +108,5 @@ To force GBM as a backend, set the following environment variables:
tools such as lxappearance or nwg-look
- `XCURSOR_THEME` - Set your cursor theme. The theme needs to be installed and
readable by your user.
- `XCURSOR_SIZE` - Set cursor size. See [here](../../faq/) for why you might
- `XCURSOR_SIZE` - Set cursor size. See [here](../../FAQ/) for why you might
want this variable set.
4 changes: 2 additions & 2 deletions pages/Configuring/Expanding-functionality.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ title: Expanding functionality
Hyprland exposes two powerful sockets for you to use.

The first, socket1, can be fully controlled with `hyprctl`, see its usage
[here](../using-hyprctl).
[here](../Using-hyprctl).

The second, socket2, sends events for certain changes / actions and can be used
to react to different events. See its description [here](../../ipc/).
to react to different events. See its description [here](../../IPC/).

## Example script

Expand Down
4 changes: 2 additions & 2 deletions pages/Configuring/Keywords.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ then lines inside `~/.config/hypr/myColors.conf`, then lines below.
Use something like
[libinput-gestures](https://github.com/bulletmark/libinput-gestures), with
`hyprctl` if you want to expand Hyprland's gestures beyond what's offered in
[Variables](../variables).
[Variables](../Variables).

## Per-device input configs

Expand Down Expand Up @@ -152,7 +152,7 @@ To set a wallpaper, use a wallpaper utility like
[hyprpaper](https://github.com/hyprwm/hyprpaper) or
[swaybg](https://github.com/swaywm/swaybg).

More can be found in [Useful Utilities](../../useful-utilities).
More can be found in [Useful Utilities](../../Useful-Utilities).

## Blurring layerSurfaces

Expand Down
8 changes: 4 additions & 4 deletions pages/Configuring/Monitors.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ monitor=name,disable
Disabling a monitor will literally remove it from the layout, moving all windows
and workspaces to any remaining ones. If you want to disable your monitor in a
screensaver style (just turn off the monitor) use the `dpms`
[dispatcher](../dispatchers).
[dispatcher](../Dispatchers).

{{</ callout >}}

Expand Down Expand Up @@ -197,7 +197,7 @@ monitor=eDP-1,2880x1800@90,0x0,1,bitdepth,10
### VRR

Per-display VRR can be done by adding `,vrr,X` where `X` is the mode from the
[variables page](../variables).
[variables page](../Variables).

## Rotating

Expand Down Expand Up @@ -241,8 +241,8 @@ This will be done automatically when

## Default workspace

See [Workspace Rules](../workspace-rules).
See [Workspace Rules](../Workspace-Rules).

### Binding workspaces to a monitor

See [Workspace Rules](../workspace-rules).
See [Workspace Rules](../Workspace-Rules).
2 changes: 1 addition & 1 deletion pages/Configuring/Uncommon-tips-&-tricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ while the `fr` layout is active.
{{< /callout >}}

You can also bind a key to execute `hyprctl switchxkblayout` for more keybind
freedom. See [Using hyprctl](../using-hyprctl).
freedom. See [Using hyprctl](../Using-hyprctl).

To find the valid layouts and `kb_options`, you can check out the
`/usr/share/X11/xkb/rules/base.lst`. For example:
Expand Down
4 changes: 2 additions & 2 deletions pages/Configuring/Using-hyprctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ _hyprctl_ calls will be dispatched by the compositor _synchronously_, meaning
any spam of the utility will cause slowdowns. It's recommended to use `--batch`
for many control calls, and limiting the amount of info calls.

For live event handling, see the [socket2](../../ipc/).
For live event handling, see the [socket2](../../IPC/).

{{< /callout >}}

Expand Down Expand Up @@ -293,7 +293,7 @@ hyprctl getoption general:border_size
hyprctl getoption input:touchpad:disable_while_typing
```

See [Variables](../variables) for section and options you can use.
See [Variables](../Variables) for section and options you can use.

## Batch

Expand Down
14 changes: 7 additions & 7 deletions pages/Configuring/Variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ weight: 2
title: Variables
---

For basic syntax info, see [Configuring Hyprland](../configuring-hyprland).
For basic syntax info, see [Configuring Hyprland](../Configuring-Hyprland).

This page documents all the "options" of Hyprland. For binds, monitors,
animations, etc. see the sidebar. For anything else, see
[Keywords](../keywords).
[Keywords](../Keywords).

Please keep in mind some options that are layout-specific will be documented in
the layout pages and not here. (See the Sidebar for Dwindle and Master layouts)
Expand Down Expand Up @@ -161,7 +161,7 @@ strain on the GPU.

{{< callout type=info >}}

_[More about Animations](../animations)._
_[More about Animations](../Animations)._

{{< /callout >}}

Expand Down Expand Up @@ -204,7 +204,7 @@ Alternatively, you can use the `localectl` command to discover what is available
on your system.

For switchable keyboard configurations, take a look at
[the uncommon tips & tricks page entry](../uncommon-tips--tricks/#switchable-keyboard-layouts).
[the uncommon tips & tricks page entry](../Uncommon-tips--tricks/#switchable-keyboard-layouts).

{{< /callout >}}

Expand Down Expand Up @@ -266,7 +266,7 @@ _Subcategory `input:touchdevice:`_

| name | description | type | default |
| --- | --- | --- | --- |
| transform | transform the input from touchdevices. The possible transformations are the same as [those of the monitors](../monitors/#rotating) | int | 0 |
| transform | transform the input from touchdevices. The possible transformations are the same as [those of the monitors](../Monitors/#rotating) | int | 0 |
| output | the monitor to bind touch devices. The default is autodetection. To stop autotection use an empty string or the "\[\[Empty\]\]" value. | string | \[\[Auto\]\] |
| enabled | Whether input is enabled for touch devices. | bool | true |

Expand All @@ -276,15 +276,15 @@ _Subcategory `input:tablet:`_

| name | description | type | default |
| --- | --- | --- | --- |
| transform | transform the input from tablets. The possible transformations are the same as [those of the monitors](../monitors/#rotating) | int | 0 |
| transform | transform the input from tablets. The possible transformations are the same as [those of the monitors](../Monitors/#rotating) | int | 0 |
| output | the monitor to bind tablets. Empty means unbound. | string | \[\[Empty\]\] |
| region_position | position of the mapped region in monitor layout. | vec2 | [0, 0] |
| region_size | size of the mapped region. When this variable is set, tablet input will be mapped to the region. [0, 0] or invalid size means unset. | vec2 | [0, 0] |
| relative_input | whether the input should be relative | bool | false |

### Per-device input config

Described [here](../keywords#per-device-input-configs).
Described [here](../Keywords#per-device-input-configs).

### Gestures

Expand Down
6 changes: 3 additions & 3 deletions pages/Configuring/Window-Rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Static rules are evaluated once at window open and never again.
| center (\[opt\]) | if the window is floating, will center it on the monitor. Set opt as 1 to respect monitor reserved area |
| pseudo | pseudotiles a window |
| monitor \[id\] | sets the monitor on which a window should open. `id` can be either id or name (either e.g. `1` or e.g. `DP-1`) |
| workspace \[w\] | sets the workspace on which a window should open (for workspace syntax, see [dispatchers->workspaces](../dispatchers#workspaces)). You can also make \[w\] to `unset`, will unset all previous workspace rules applied to this window. You can also add `silent` after the workspace to make the window open silently. |
| workspace \[w\] | sets the workspace on which a window should open (for workspace syntax, see [dispatchers->workspaces](../Dispatchers#workspaces)). You can also make \[w\] to `unset`, will unset all previous workspace rules applied to this window. You can also add `silent` after the workspace to make the window open silently. |
| nofocus | disables focus to the window |
| noinitialfocus | disables the initial focus to the window |
| forceinput | forces an XWayland window to receive input, even if it requests not to do so. (Might fix issues like e.g. Game Launchers not receiving focus for some reason) |
Expand Down Expand Up @@ -141,11 +141,11 @@ Dynamic rules are re-evaluated every time a property changes.
| noshadow | disables shadows for the window |
| noanim | disables the animations for the window |
| keepaspectratio | forces aspect ratio when resizing window with the mouse |
| bordercolor \[c\] | force the bordercolor of the window. Options for c: `color`/`color ... color angle` -> sets the active border color/gradient OR `color color`/`color ... color angle color ... color [angle]` -> sets the active and inactive border color/gradient of the window. See [variables->colors](../variables#variable_types) for color definition. |
| bordercolor \[c\] | force the bordercolor of the window. Options for c: `color`/`color ... color angle` -> sets the active border color/gradient OR `color color`/`color ... color angle color ... color [angle]` -> sets the active and inactive border color/gradient of the window. See [variables->colors](../Variables#variable-types) for color definition. |
| idleinhibit \[mode\] | sets an idle inhibit rule for the window. If active, apps like `hypridle` will not fire. Modes: `none`, `always`, `focus`, `fullscreen` |
| dimaround | dims everything around the window . Please note this rule is meant for floating windows and using it on tiled ones may result in strange behavior. |
| xray \[on\] | sets blur xray mode for the window (0 for off, 1 for on, unset for default) |
| immediate | forces the window to allow to be torn. See [the Tearing page](../tearing). |
| immediate | forces the window to allow to be torn. See [the Tearing page](../Tearing). |
| nearestneighbor | forces the window to use the nearest neigbor filtering. |

{{< callout type=info >}}
Expand Down
14 changes: 7 additions & 7 deletions pages/Configuring/Workspace-Rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ instance, you can define a workspace where all windows are drawn without borders
or gaps.

For layout-specific rules, see the specific layout page. For example:
[Master Layout->Workspace Rules](../master-layout#workspace-rules)
[Master Layout->Workspace Rules](../Master-Layout#workspace-rules)

### Syntax

Expand All @@ -19,7 +19,7 @@ workspace=WORKSPACE,RULES
```

- WORKSPACE is a valid workspace identifier (see
[Dispatchers->Workspaces](../dispatchers#workspaces)). This field is
[Dispatchers->Workspaces](../Dispatchers#workspaces)). This field is
mandatory;
- RULES is one (or more) rule(s) as described here in [rules](#rules).

Expand All @@ -34,17 +34,17 @@ workspace=3,rounding:false,bordersize:0

| Rule | Description | type |
| --- | --- | --- |
| monitor:[m] | Binds a workspace to a monitor See [syntax](#syntax) and [Monitors](../monitors). | string |
| monitor:[m] | Binds a workspace to a monitor See [syntax](#syntax) and [Monitors](../Monitors). | string |
| default:[b] | Whether this workspace should be the default workspace for the given monitor | bool |
| gapsin:[x] | Set the gaps between windows (equivalent to [General->gaps_in](../variables#general)) | int |
| gapsout:[x] | Set the gaps between windows and monitor edges (equivalent to [General->gaps_out](../variables#general)) | int |
| bordersize:[x] | Set the border size around windows (equivalent to [General->border_size](../variables#general)) | int |
| gapsin:[x] | Set the gaps between windows (equivalent to [General->gaps_in](../Variables#general)) | int |
| gapsout:[x] | Set the gaps between windows and monitor edges (equivalent to [General->gaps_out](../Variables#general)) | int |
| bordersize:[x] | Set the border size around windows (equivalent to [General->border_size](../Variables#general)) | int |
| border:[b] | Whether to draw borders or not | bool |
| shadow:[b] | Whether to draw shadows or not | bool |
| rounding:[b] | Whether to draw rounded windows or not | bool |
| decorate:[b] | Whether to draw window decorations or not | bool |
| persistent:[b] | Keep this workspace alive even if empty and inactive | bool |
| on-created-empty:[c] | A command to be executed once a workspace is created empty (i.e. not created by moving a window to it). See the [command syntax](../dispatchers#executing-with-rules) | string |
| on-created-empty:[c] | A command to be executed once a workspace is created empty (i.e. not created by moving a window to it). See the [command syntax](../Dispatchers#executing-with-rules) | string |
| defaultName:[s] | A default name for the workspace. | string |

### Example Rules
Expand Down
2 changes: 1 addition & 1 deletion pages/Configuring/XWayland.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ XWayland currently looks pixelated on HiDPI screens, due to Xorg's inability to
scale.

This problem is mitigated by the
[`xwayland:force_zero_scaling`](../../configuring/variables/#xwayland) option,
[`xwayland:force_zero_scaling`](../Variables/#xwayland) option,
which forces XWayland windows not to be scaled.

This will get rid of the pixelated look, but will not scale applications
Expand Down
2 changes: 1 addition & 1 deletion pages/Contributing and Debugging/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Contributing and Debugging

# Contributing guidelines

PR, code styling and code FAQs are [here](./pr-guidelines)
PR, code styling and code FAQs are [here](./PR-Guidelines)

For issues, please see
[the guidelines](https://github.com/hyprwm/Hyprland/blob/main/docs/ISSUE_GUIDELINES.md)
Expand Down
2 changes: 1 addition & 1 deletion pages/Crashes and Bugs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Report an issue on GitHub or on the Discord server.

## Bugs

First of all, **_READ THE [FAQ PAGE](../faq)_**
First of all, **_READ THE [FAQ PAGE](../FAQ)_**

If your bug is not listed there, you can ask on the Discord server or open an
issue on GitHub.
Expand Down
23 changes: 11 additions & 12 deletions pages/FAQ/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ This just means they are running through XWayland, which physically cannot scale
by fractional amounts.

To force them to run in wayland-native mode, see
[the Master Tutorial](../../getting-started/master-tutorial/#force-apps-to-use-wayland).
[the Master Tutorial](../Getting-Started/Master-Tutorial/#force-apps-to-use-wayland).

If they can't, see [the XWayland page](../../configuring/xwayland).
If they can't, see [the XWayland page](../Configuring/XWayland).

### Nothing renders / screen is empty / crash on opening first app

Expand All @@ -24,11 +24,11 @@ up themes with envvars) to set up your themes.

> Your PC is very, _very_ old.
In that case, see the [Installation Page](../../getting-started/installation)
In that case, see the [Installation Page](../Getting-Started/Installation)
and try compiling with LEGACY_RENDERER

_For more info about bugs and crashes, see this_
_[wiki page](../../crashes-and-bugs)_
_[wiki page](../Crashes-and-Bugs)_

### Me cursor no render?

Expand Down Expand Up @@ -81,13 +81,13 @@ For recording videos, [wf-recorder](https://github.com/ammen99/wf-recorder),

### Screenshare / OBS no worky

Check [Screensharing](../useful-utilities/screen-sharing).
Check [Screensharing](../Useful-Utilities/Screen-Sharing).

Also install `qt6-wayland` if you plan to use obs.

### How do I change my wallpaper?

See [Wallpapers](../useful-utilities/wallpapers).
See [Wallpapers](../Useful-Utilities/Wallpapers).

### How heavy is this?

Expand Down Expand Up @@ -126,8 +126,7 @@ Use a wayland-compatible locking utility using WLR protocols, e.g. `swaylock`.

### How do I change me mouse cursor?

See [hyprcursor](../hypr-ecosystem/hyprcursor)
||||||| parent of 0fcc6e5 (treewide: replace hint with callout)
See [hyprcursor](../Hypr-Ecosystem/hyprcursor)
1. Set the GTK cursor using [nwg-look](https://github.com/nwg-piotr/nwg-look).
2. Add `exec-once=hyprctl setcursor [THEME] [SIZE]` to your config and restart Hyprland.

Expand Down Expand Up @@ -155,7 +154,7 @@ it with the `exec-once` keyword.
### Waybar workspaces no worky???

Waybar has a set of caveats or settings that you need to be aware of. See
[Status bars](../useful-utilities/status-bars) for solutions.
[Status bars](../Useful-Utilities/Status-Bars) for solutions.

### How do I autostart my favorite apps?

Expand Down Expand Up @@ -238,7 +237,7 @@ taste.
### How do I export envvars for Hyprland?
See [Environment Variables](../configuring/environment-variables)
See [Environment Variables](../Configuring/Environment-variables)
The `env` keyword is used for this purpose. For example:
Expand Down Expand Up @@ -289,11 +288,11 @@ copy -> found copied text...). Therefore this method is not recommended.**
### How to fix games with window dancing?
Read [this trick](../configuring/uncommon-tips--tricks/#window-dancing).
Read [this trick](../Configuring/Uncommon-tips--tricks/#window-dancing).
### My apps take a long time to start / can't screenshare
See [The XDPH Page](../useful-utilities/xdg-desktop-portal-hyprland).
See [The XDPH Page](../Useful-Utilities/xdg-desktop-portal-hyprland).
You most likely have multiple portal impls / an impl is failing to launch.
Expand Down
Loading

0 comments on commit 22d5e48

Please sign in to comment.