From 87e0cede462e68d38c024362dfcdd1713ff26b38 Mon Sep 17 00:00:00 2001 From: Mihai Fufezan Date: Sun, 17 Mar 2024 14:44:39 +0200 Subject: [PATCH] capitalize links --- pages/Configuring/Binds.md | 8 +++---- pages/Configuring/Configuring-Hyprland.md | 6 ++--- pages/Configuring/Dispatchers.md | 4 ++-- pages/Configuring/Environment-variables.md | 2 +- pages/Configuring/Expanding-functionality.md | 4 ++-- pages/Configuring/Keywords.md | 4 ++-- pages/Configuring/Monitors.md | 8 +++---- pages/Configuring/Uncommon-tips-&-tricks.md | 2 +- pages/Configuring/Using-hyprctl.md | 4 ++-- pages/Configuring/Variables.md | 14 +++++------ pages/Configuring/Window-Rules.md | 6 ++--- pages/Configuring/Workspace-Rules.md | 14 +++++------ pages/Configuring/XWayland.md | 2 +- pages/Contributing and Debugging/_index.md | 2 +- pages/Crashes and Bugs/_index.md | 2 +- pages/FAQ/_index.md | 23 +++++++++---------- pages/Getting Started/Installation.md | 8 +++---- pages/Getting Started/Master-Tutorial.md | 18 +++++++-------- pages/Hypr Ecosystem/hyprcursor.md | 6 ++++- .../xdg-desktop-portal-hyprland.md | 4 ++-- pages/IPC/_index.md | 2 +- pages/Nix/Hyprland on NixOS.md | 6 ++--- pages/Nix/Hyprland on other distros.md | 4 ++-- pages/Nix/Options & Overrides.md | 6 ++--- pages/Nix/_index.md | 6 ++--- pages/Plugins/Development/Getting-Started.md | 6 ++--- pages/Plugins/Using-Plugins.md | 2 +- pages/Useful Utilities/_index.md | 20 ++++++++-------- pages/_index.md | 4 ++-- 29 files changed, 100 insertions(+), 97 deletions(-) diff --git a/pages/Configuring/Binds.md b/pages/Configuring/Binds.md index 65cfa16..f57d1b4 100644 --- a/pages/Configuring/Binds.md +++ b/pages/Configuring/Binds.md @@ -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 @@ -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 SUPER + F10, and you want to make it work globally. @@ -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). {{}} diff --git a/pages/Configuring/Configuring-Hyprland.md b/pages/Configuring/Configuring-Hyprland.md index 43d3cec..ae24205 100644 --- a/pages/Configuring/Configuring-Hyprland.md +++ b/pages/Configuring/Configuring-Hyprland.md @@ -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 >}} @@ -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. diff --git a/pages/Configuring/Dispatchers.md b/pages/Configuring/Dispatchers.md index a360b6e..bead53f 100644 --- a/pages/Configuring/Dispatchers.md +++ b/pages/Configuring/Dispatchers.md @@ -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 >}} diff --git a/pages/Configuring/Environment-variables.md b/pages/Configuring/Environment-variables.md index 77eeb9d..88b04b2 100644 --- a/pages/Configuring/Environment-variables.md +++ b/pages/Configuring/Environment-variables.md @@ -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. diff --git a/pages/Configuring/Expanding-functionality.md b/pages/Configuring/Expanding-functionality.md index 4e78a67..f252443 100644 --- a/pages/Configuring/Expanding-functionality.md +++ b/pages/Configuring/Expanding-functionality.md @@ -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 diff --git a/pages/Configuring/Keywords.md b/pages/Configuring/Keywords.md index 9fa5ead..60a1829 100644 --- a/pages/Configuring/Keywords.md +++ b/pages/Configuring/Keywords.md @@ -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 @@ -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 diff --git a/pages/Configuring/Monitors.md b/pages/Configuring/Monitors.md index d4531df..8dcb558 100644 --- a/pages/Configuring/Monitors.md +++ b/pages/Configuring/Monitors.md @@ -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). {{}} @@ -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 @@ -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). diff --git a/pages/Configuring/Uncommon-tips-&-tricks.md b/pages/Configuring/Uncommon-tips-&-tricks.md index 20b0f0d..0c3b093 100644 --- a/pages/Configuring/Uncommon-tips-&-tricks.md +++ b/pages/Configuring/Uncommon-tips-&-tricks.md @@ -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: diff --git a/pages/Configuring/Using-hyprctl.md b/pages/Configuring/Using-hyprctl.md index fd450b5..d58f0d9 100644 --- a/pages/Configuring/Using-hyprctl.md +++ b/pages/Configuring/Using-hyprctl.md @@ -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 >}} @@ -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 diff --git a/pages/Configuring/Variables.md b/pages/Configuring/Variables.md index 6b27138..85dd3b0 100644 --- a/pages/Configuring/Variables.md +++ b/pages/Configuring/Variables.md @@ -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) @@ -161,7 +161,7 @@ strain on the GPU. {{< callout type=info >}} -_[More about Animations](../animations)._ +_[More about Animations](../Animations)._ {{< /callout >}} @@ -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 >}} @@ -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 | @@ -276,7 +276,7 @@ _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] | @@ -284,7 +284,7 @@ _Subcategory `input:tablet:`_ ### Per-device input config -Described [here](../keywords#per-device-input-configs). +Described [here](../Keywords#per-device-input-configs). ### Gestures diff --git a/pages/Configuring/Window-Rules.md b/pages/Configuring/Window-Rules.md index 30054e6..c150b07 100644 --- a/pages/Configuring/Window-Rules.md +++ b/pages/Configuring/Window-Rules.md @@ -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) | @@ -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 >}} diff --git a/pages/Configuring/Workspace-Rules.md b/pages/Configuring/Workspace-Rules.md index 9a08e3e..9319ac8 100644 --- a/pages/Configuring/Workspace-Rules.md +++ b/pages/Configuring/Workspace-Rules.md @@ -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 @@ -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). @@ -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 diff --git a/pages/Configuring/XWayland.md b/pages/Configuring/XWayland.md index 37ae258..fe8d587 100644 --- a/pages/Configuring/XWayland.md +++ b/pages/Configuring/XWayland.md @@ -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 diff --git a/pages/Contributing and Debugging/_index.md b/pages/Contributing and Debugging/_index.md index 245ffe7..303679f 100644 --- a/pages/Contributing and Debugging/_index.md +++ b/pages/Contributing and Debugging/_index.md @@ -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) diff --git a/pages/Crashes and Bugs/_index.md b/pages/Crashes and Bugs/_index.md index d80b620..ec25269 100644 --- a/pages/Crashes and Bugs/_index.md +++ b/pages/Crashes and Bugs/_index.md @@ -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. diff --git a/pages/FAQ/_index.md b/pages/FAQ/_index.md index 8738318..fe6b9c6 100644 --- a/pages/FAQ/_index.md +++ b/pages/FAQ/_index.md @@ -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 @@ -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? @@ -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? @@ -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. @@ -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? @@ -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: @@ -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. diff --git a/pages/Getting Started/Installation.md b/pages/Getting Started/Installation.md index f58f7ee..ad7ef9e 100644 --- a/pages/Getting Started/Installation.md +++ b/pages/Getting Started/Installation.md @@ -7,7 +7,7 @@ title: Installation Due to their proprietary nature, Nvidia GPUs have limited compatibility with Hyprland. If you want to try Hyprland on Nvidia regardless (many people have -reported successes), follow the [Nvidia page](../../nvidia) after installing +reported successes), follow the [Nvidia page](../../Nvidia) after installing Hyprland. ## Distros @@ -52,7 +52,7 @@ Enable Hyprland in your NixOS configuration: programs.hyprland.enable = true; ``` -For more details, read the [Nix page](../../nix). +For more details, read the [Nix page](../../Nix). {{% /details %}} @@ -278,12 +278,12 @@ ninja -C build ninja -C build install --tags runtime,man ``` -Refer to [Debugging](../../contributing-and-debugging) to see how to build & +Refer to [Debugging](../../Contributing-and-Debugging) to see how to build & debug. ## Crash on launch -See [Crashes and Bugs](../../crashes-and-bugs). +See [Crashes and Bugs](../../Crashes-and-Bugs). ## Custom installation (legacy renderer, etc) diff --git a/pages/Getting Started/Master-Tutorial.md b/pages/Getting Started/Master-Tutorial.md index 72e3f90..7fa9b60 100644 --- a/pages/Getting Started/Master-Tutorial.md +++ b/pages/Getting Started/Master-Tutorial.md @@ -12,7 +12,7 @@ necessary. ## Install Hyprland -See [Installation](../installation) and come back here once you have +See [Installation](../Installation) and come back here once you have successfully installed Hyprland. Install `kitty` (default terminal emulator) terminal. This is available in most @@ -22,7 +22,7 @@ distros' repositories. _If not using an NVIDIA card, skip this step_ -Please take a look at [The Nvidia page](../../nvidia) before launching. It has a +Please take a look at [The Nvidia page](../../Nvidia) before launching. It has a lot of info regarding the needed environment and tweaks. ## VM? @@ -69,17 +69,17 @@ If you want the best experience with less hassle googling, keep reading. ## Critical software -See the [Must-have Software page](../../useful-utilities/must-have) for the +See the [Must-have Software page](../../Useful-Utilities/Must-have) for the crucial things to make Wayland / Hyprland / other apps work correctly. ## Monitors config -See [Configuring Hyprland page](../../configuring/monitors) to learn all about +See [Configuring Hyprland page](../../Configuring/Monitors) to learn all about configuring your displays. ## Apps / X11 replacements -See the [Useful Utilities page](../../useful-utilities) and the +See the [Useful Utilities page](../../Useful-Utilities) and the [Sway wiki page](https://github.com/swaywm/sway/wiki/Useful-add-ons-for-sway) just about that. You can also visit the [Awesome-Hyprland](https://github.com/hyprland-community/awesome-hyprland) @@ -88,16 +88,16 @@ repository for a more comprehensive list. ## Fully configure Head onto the -[Configuring Hyprland page](../../configuring/configuring-hyprland) to learn all +[Configuring Hyprland page](../../Configuring/Configuring-Hyprland) to learn all about configuring Hyprland to your likings. ## Cursors Cursors are a notorious pain to set up when you don't know how. See -[this FAQ entry](../../faq#how-do-i-change-me-mouse-cursor) +[this FAQ entry](../../FAQ#how-do-i-change-me-mouse-cursor) If your cursor does not appear, then see -[this FAQ entry](../../faq#me-cursor-no-render) +[this FAQ entry](../../FAQ#me-cursor-no-render) ## Themes @@ -118,7 +118,7 @@ For most electron apps, you should put the above in `~/.config/electron-flags.conf`. VSCode is known to not work with that though. A few more environment variables for forcing Wayland mode are documented -[here](../../configuring/environment-variables). +[here](../../Configuring/Environment-variables). You can check whether an app is running in xwayland or not with `hyprctl clients`. diff --git a/pages/Hypr Ecosystem/hyprcursor.md b/pages/Hypr Ecosystem/hyprcursor.md index 42e6ea2..0117fff 100644 --- a/pages/Hypr Ecosystem/hyprcursor.md +++ b/pages/Hypr Ecosystem/hyprcursor.md @@ -1,3 +1,7 @@ +--- +weight: 5 +title: hyprcursor +--- hyprcursor is a new cursor theme format that has many advantages over the widely used xcursor. @@ -50,4 +54,4 @@ icons and XCursors in both `/usr/share/icons` and `~/.icons`. ## I don't want to use hyprcursor If you don't have any hyprcursor themes installed, hyprland will fall back to XCursor, and use -whatever you define with `XCURSOR_THEME` and `XCURSOR_SIZE`. \ No newline at end of file +whatever you define with `XCURSOR_THEME` and `XCURSOR_SIZE`. diff --git a/pages/Hypr Ecosystem/xdg-desktop-portal-hyprland.md b/pages/Hypr Ecosystem/xdg-desktop-portal-hyprland.md index 7d74671..dcacb3c 100644 --- a/pages/Hypr Ecosystem/xdg-desktop-portal-hyprland.md +++ b/pages/Hypr Ecosystem/xdg-desktop-portal-hyprland.md @@ -1,5 +1,5 @@ --- -weight: 5 +weight: 6 title: xdg-desktop-portal-hyprland --- @@ -13,4 +13,4 @@ No configuration. ## Troubleshooting See the -[XDG Desktop Portal wiki page](../../useful-utilities/xdg-desktop-portal-hyprland). +[XDG Desktop Portal wiki page](../../Useful-Utilities/xdg-desktop-portal-hyprland). diff --git a/pages/IPC/_index.md b/pages/IPC/_index.md index a070744..5657f2e 100644 --- a/pages/IPC/_index.md +++ b/pages/IPC/_index.md @@ -15,7 +15,7 @@ echo $HYPRLAND_INSTANCE_SIGNATURE ## /tmp/hypr/\[HIS\]/.socket.sock Used for hyprctl-like requests. See the -[Hyprctl page](../configuring/using-hyprctl) for commands. +[Hyprctl page](../Configuring/Using-hyprctl) for commands. basically, write `[flag(s)]/command args`. diff --git a/pages/Nix/Hyprland on NixOS.md b/pages/Nix/Hyprland on NixOS.md index 964046b..27913f8 100644 --- a/pages/Nix/Hyprland on NixOS.md +++ b/pages/Nix/Hyprland on NixOS.md @@ -39,7 +39,7 @@ This will use the Hyprland version that Nixpkgs has. {{< callout >}} -Please enable [Cachix](../cachix) before using the flake package, so you don't +Please enable [Cachix](../Cachix) before using the flake package, so you don't have to compile Hyprland yourself. {{< /callout >}} @@ -82,7 +82,7 @@ Don't forget to change the `HOSTNAME` to your actual hostname! {{< callout >}} -Please enable [Cachix](../cachix) before using the flake package, so you don't +Please enable [Cachix](../Cachix) before using the flake package, so you don't have to compile Hyprland yourself. {{< /callout >}} @@ -111,4 +111,4 @@ in { ## Fixing problems with themes If your themes for mouse cursor, icons or windows don't load correctly, see the -relevant section in [Hyprland on Home Manager](../hyprland-on-home-manager). +relevant section in [Hyprland on Home Manager](../Hyprland-on-Home-Manager). diff --git a/pages/Nix/Hyprland on other distros.md b/pages/Nix/Hyprland on other distros.md index e3cee06..20d8150 100644 --- a/pages/Nix/Hyprland on other distros.md +++ b/pages/Nix/Hyprland on other distros.md @@ -4,7 +4,7 @@ title: Hyprland on other distros If you use Nix on distros other than NixOS, you can still use Hyprland. -The best option would be through [Home Manager](../hyprland-on-home-manager). +The best option would be through [Home Manager](../Hyprland-on-Home-Manager). However, if Home Manager is not for you, you can use it as a normal package. @@ -25,7 +25,7 @@ nix profile install nixpkgs#hyprland {{< tab "From the Flake" >}} -NOTE: Make sure to enable [Cachix](../cachix) first. +NOTE: Make sure to enable [Cachix](../Cachix) first. ```sh nix profile install github:hyprwm/Hyprland diff --git a/pages/Nix/Options & Overrides.md b/pages/Nix/Options & Overrides.md index 92cd007..fa3f4af 100644 --- a/pages/Nix/Options & Overrides.md +++ b/pages/Nix/Options & Overrides.md @@ -3,8 +3,8 @@ title: Options & Overrides --- You can override the package through `.override` or `.overrideAttrs`. This is -easily achievable on [NixOS](../hyprland-on-nixos) or -[Home Manager](../hyprland-on-home-manager). +easily achievable on [NixOS](../Hyprland-on-NixOS) or +[Home Manager](../Hyprland-on-Home-Manager). ## Package options @@ -39,7 +39,7 @@ the package itself, or through the module options. ### XWayland HiDPI -See [XWayland](../../configuring/xwayland). +See [XWayland](../../Configuring/XWayland). ## Using Nix repl diff --git a/pages/Nix/_index.md b/pages/Nix/_index.md index eb596e1..0889dda 100644 --- a/pages/Nix/_index.md +++ b/pages/Nix/_index.md @@ -32,11 +32,11 @@ Note that the command to run hyprland is `Hyprland` (with a capital `H`) and not For more options, see [module options](https://search.nixos.org/options?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=hyprland). -For other NixOS options, see [Hyprland on NixOS](./hyprland-on-nixos). +For other NixOS options, see [Hyprland on NixOS](./Hyprland-on-NixOS). ## Home-manager module -Read [Hyprland on Home Manager](./hyprland-on-home-manager). +Read [Hyprland on Home Manager](./Hyprland-on-Home-Manager). For the adventurous, [@spikespaz](https://github.com/spikespaz) has made a Hyprland module that can be used in Home Manager and NixOS. It can be found @@ -44,4 +44,4 @@ Hyprland module that can be used in Home Manager and NixOS. It can be found ## Options and overrides -Read [Options & Overrides](./options--overrides). +Read [Options & Overrides](./Options-Overrides). diff --git a/pages/Plugins/Development/Getting-Started.md b/pages/Plugins/Development/Getting-Started.md index dd1ad1a..03c2787 100644 --- a/pages/Plugins/Development/Getting-Started.md +++ b/pages/Plugins/Development/Getting-Started.md @@ -142,12 +142,12 @@ your plugin in the nested session without worrying about nuking your actual session, and also being able to debug it easily. See more info in -[the Contributing Section](https://wiki.hyprland.org/Contributing-and-Debugging/#nesting-hyprland) +[the Contributing Section](../../Contributing-and-Debugging/#nesting-hyprland) ### More advanced stuff Take a look at the `src/plugins/PluginAPI.hpp` header. It has comments to every method to let you know what it is. -For more explanation on a few concepts, see [Advanced](../advanced) and -[Plugin Guidelines](../plugin-guidelines) +For more explanation on a few concepts, see [Advanced](../Advanced) and +[Plugin Guidelines](../Plugin-Guidelines) diff --git a/pages/Plugins/Using-Plugins.md b/pages/Plugins/Using-Plugins.md index e602792..b844574 100644 --- a/pages/Plugins/Using-Plugins.md +++ b/pages/Plugins/Using-Plugins.md @@ -86,7 +86,7 @@ Oh no. Oopsie. Usually means a plugin is broken. `hyprpm disable` it. ### How do I make my own plugin? -See [here](../development/getting-started). +See [here](../Development/Getting-Started). ### Where do I find plugins? diff --git a/pages/Useful Utilities/_index.md b/pages/Useful Utilities/_index.md index 4736c57..fff26ca 100644 --- a/pages/Useful Utilities/_index.md +++ b/pages/Useful Utilities/_index.md @@ -8,24 +8,24 @@ Hyprland working. ## List of Pages -- **[Must-Have](./must-have)** +- **[Must-Have](./Must-have)** -- **[Hypr Ecosystem](./hypr-ecosystem)** +- **[Hypr Ecosystem](./Hypr-Ecosystem)** -- **[Status Bars](./status-bars)** +- **[Status Bars](./Status-Bars)** -- **[App Launchers](./app-launchers)** +- **[App Launchers](./App-Launchers)** -- **[Wallpapers](./wallpapers)** +- **[Wallpapers](./Wallpapers)** -- **[Screen Sharing](./screen-sharing)** +- **[Screen Sharing](./Screen-Sharing)** -- **[App Clients](./app-clients)** +- **[App Clients](./App-Clients)** -- **[Color Pickers](./color-pickers)** +- **[Color Pickers](./Color-Pickers)** -- **[Clipboard Managers](./clipboard-managers)** +- **[Clipboard Managers](./Clipboard-Managers)** - **[Hyprland Desktop Portal](./xdg-desktop-portal-hyprland)** -- **[Other](./other)** +- **[Other](./Other)** diff --git a/pages/_index.md b/pages/_index.md index 765fa5a..828d423 100644 --- a/pages/_index.md +++ b/pages/_index.md @@ -15,14 +15,14 @@ A Wayland compositor is a fully autonomous Display Server, like Xorg itself. It is **not** possible to mix'n'match Wayland compositors like you could on Xorg with window managers and compositors. It is also not entirely possible, nor recommended, to try and use all Xorg applications on Wayland. See -[this page](../useful-utilities) for a list of recommended Wayland +[this page](../Useful-Utilities) for a list of recommended Wayland native/compatible programs. Wayland **compositors** should not be confused with Xorg **window managers**. ## IMPORTANT -If you are having issues, please try [reading the FAQ](../faq) and configuring +If you are having issues, please try [reading the FAQ](../FAQ) and configuring sections — chances are your issue is described somewhere there. If not, you can try [searching the issues](https://github.com/hyprwm/Hyprland/issues) or [joining the Discord server](https://discord.gg/hQ9XvMUjjr).