summaryrefslogtreecommitdiff
path: root/docs/guide
diff options
context:
space:
mode:
authorAylur <[email protected]>2024-11-08 18:31:49 +0000
committerAylur <[email protected]>2024-11-08 18:32:02 +0000
commit321350f7d52a65afae095cd5b874c1866084fb64 (patch)
treeb898464db36d8d89bded6da095ffc1d74fd2e070 /docs/guide
parent5ee98ff298a9bdf40535c3c15aa5952778b9df39 (diff)
docs: swap install and usage sections on lib pages
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/libraries/apps.md68
-rw-r--r--docs/guide/libraries/auth.md90
-rw-r--r--docs/guide/libraries/battery.md78
-rw-r--r--docs/guide/libraries/bluetooth.md78
-rw-r--r--docs/guide/libraries/cava.md80
-rw-r--r--docs/guide/libraries/greet.md78
-rw-r--r--docs/guide/libraries/hyprland.md68
-rw-r--r--docs/guide/libraries/mpris.md92
-rw-r--r--docs/guide/libraries/network.md68
-rw-r--r--docs/guide/libraries/notifd.md68
-rw-r--r--docs/guide/libraries/powerprofiles.md78
-rw-r--r--docs/guide/libraries/references.md2
-rw-r--r--docs/guide/libraries/river.md68
-rw-r--r--docs/guide/libraries/tray.md68
-rw-r--r--docs/guide/libraries/wireplumber.md68
15 files changed, 527 insertions, 525 deletions
diff --git a/docs/guide/libraries/apps.md b/docs/guide/libraries/apps.md
index 1871d18..f1748db 100644
--- a/docs/guide/libraries/apps.md
+++ b/docs/guide/libraries/apps.md
@@ -3,40 +3,6 @@
Library and CLI tool for querying and launching
applications that have a corresponding `.desktop` file.
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson vala json-glib gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-sudo apt install meson valac libjson-glib-dev gobject-introspection
-```
-
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/apps
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [Apps reference](https://aylur.github.io/libastal/apps).
@@ -106,3 +72,37 @@ foreach (var app in apps.fuzzy_query("firefox")) {
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson vala json-glib gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson valac libjson-glib-dev gobject-introspection
+```
+
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/apps
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
diff --git a/docs/guide/libraries/auth.md b/docs/guide/libraries/auth.md
index d5f0a49..b52e38a 100644
--- a/docs/guide/libraries/auth.md
+++ b/docs/guide/libraries/auth.md
@@ -2,51 +2,6 @@
Library and CLI tool for authentication using [pam](https://github.com/linux-pam/linux-pam).
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson pam gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson pam-devel gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-# Not yet documented
-```
-
-:::
-
-::: warning On NixOS you have to add `astal-auth` to `security.pam`.
-::: code-group
-
-```nix [configuration.nix]
-{
- security.pam.services.astal-auth = {}
-}
-```
-
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/auth
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [Auth reference](https://aylur.github.io/libastal/auth).
@@ -105,3 +60,48 @@ end)
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson pam gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson pam-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+# Not yet documented
+```
+
+:::
+
+::: warning On NixOS you have to add `astal-auth` to `security.pam`.
+::: code-group
+
+```nix [configuration.nix]
+{
+ security.pam.services.astal-auth = {}
+}
+```
+
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/auth
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
diff --git a/docs/guide/libraries/battery.md b/docs/guide/libraries/battery.md
index 56f955c..7e6fe24 100644
--- a/docs/guide/libraries/battery.md
+++ b/docs/guide/libraries/battery.md
@@ -2,45 +2,6 @@
Library and CLI tool for monitoring [upowerd](https://upower.freedesktop.org/) devices.
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson vala json-glib gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-sudo apt install meson valac libjson-glib-dev gobject-introspection
-```
-
-:::
-
-::: info
-Although UPower is not a direct build dependency,
-it should be self-explanatory that the daemon is required to be available at runtime.
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/battery
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [Battery reference](https://aylur.github.io/libastal/battery).
@@ -84,3 +45,42 @@ print(battery.percentage)
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson vala json-glib gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson valac libjson-glib-dev gobject-introspection
+```
+
+:::
+
+::: info
+Although UPower is not a direct build dependency,
+it should be self-explanatory that the daemon is required to be available at runtime.
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/battery
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
diff --git a/docs/guide/libraries/bluetooth.md b/docs/guide/libraries/bluetooth.md
index 03ac9c9..9a3e5b8 100644
--- a/docs/guide/libraries/bluetooth.md
+++ b/docs/guide/libraries/bluetooth.md
@@ -2,45 +2,6 @@
Library for monitoring [bluez](https://www.bluez.org/) over dbus.
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson vala gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson vala valadoc gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-sudo apt install meson valac gobject-introspection
-```
-
-:::
-
-::: info
-Although bluez is not a direct build dependency,
-it should be self-explanatory that the daemon is required to be available at runtime.
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/bluetooth
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [Bluetooth reference](https://aylur.github.io/libastal/bluetooth).
@@ -91,3 +52,42 @@ end
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson vala gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson vala valadoc gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson valac gobject-introspection
+```
+
+:::
+
+::: info
+Although bluez is not a direct build dependency,
+it should be self-explanatory that the daemon is required to be available at runtime.
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/bluetooth
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
diff --git a/docs/guide/libraries/cava.md b/docs/guide/libraries/cava.md
index e695e16..60b2824 100644
--- a/docs/guide/libraries/cava.md
+++ b/docs/guide/libraries/cava.md
@@ -2,6 +2,46 @@
Audio visualizer using [cava](https://github.com/karlstav/cava).
+## Usage
+
+You can browse the [Cava reference](https://aylur.github.io/libastal/cava).
+
+### CLI
+
+There is no CLI for this library, use the one provided by cava.
+
+```sh
+cava
+```
+
+### Library
+
+:::code-group
+
+```js [<i class="devicon-javascript-plain"></i> JavaScript]
+import Cava from "gi://AstalCava"
+
+const cava = Cava.get_default()
+
+cava.connect("notify::values", () => {
+ print(cava.get_values())
+})
+```
+
+```py [<i class="devicon-python-plain"></i> Python]
+# Not yet documented
+```
+
+```lua [<i class="devicon-lua-plain"></i> Lua]
+-- Not yet documented
+```
+
+```vala [<i class="devicon-vala-plain"></i> Vala]
+// Not yet documented
+```
+
+:::
+
## Installation
1. install dependencies
@@ -49,43 +89,3 @@ meson setup --prefix /usr build
```
:::
-
-## Usage
-
-You can browse the [Cava reference](https://aylur.github.io/libastal/cava).
-
-### CLI
-
-There is no CLI for this library, use the one provided by cava.
-
-```sh
-cava
-```
-
-### Library
-
-:::code-group
-
-```js [<i class="devicon-javascript-plain"></i> JavaScript]
-import Cava from "gi://AstalCava"
-
-const cava = Cava.get_default()
-
-cava.connect("notify::values", () => {
- print(cava.get_values())
-})
-```
-
-```py [<i class="devicon-python-plain"></i> Python]
-# Not yet documented
-```
-
-```lua [<i class="devicon-lua-plain"></i> Lua]
--- Not yet documented
-```
-
-```vala [<i class="devicon-vala-plain"></i> Vala]
-// Not yet documented
-```
-
-:::
diff --git a/docs/guide/libraries/greet.md b/docs/guide/libraries/greet.md
index f0cd012..47f98b9 100644
--- a/docs/guide/libraries/greet.md
+++ b/docs/guide/libraries/greet.md
@@ -2,45 +2,6 @@
Library and CLI tool for sending requests to [greetd](https://sr.ht/~kennylevinsen/greetd/).
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson vala json-glib gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-sudo apt install meson valac libjson-glib-dev gobject-introspection
-```
-
-:::
-
-::: info
-Although `greetd` is not a direct build dependency,
-it should be self-explanatory that the daemon is required to be available at runtime.
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/greet
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [Greet reference](https://aylur.github.io/libastal/greet).
@@ -92,3 +53,42 @@ try {
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson vala json-glib gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson valac libjson-glib-dev gobject-introspection
+```
+
+:::
+
+::: info
+Although `greetd` is not a direct build dependency,
+it should be self-explanatory that the daemon is required to be available at runtime.
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/greet
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
diff --git a/docs/guide/libraries/hyprland.md b/docs/guide/libraries/hyprland.md
index 94a398f..82d9e9d 100644
--- a/docs/guide/libraries/hyprland.md
+++ b/docs/guide/libraries/hyprland.md
@@ -2,40 +2,6 @@
Library and CLI tool for monitoring the [Hyprland socket](https://wiki.hyprland.org/IPC/).
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson vala json-glib gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-sudo apt install meson valac libjson-glib-dev gobject-introspection
-```
-
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/hyprland
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [Hyprland reference](https://aylur.github.io/libastal/hyprland).
@@ -84,3 +50,37 @@ end
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson vala json-glib gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson valac libjson-glib-dev gobject-introspection
+```
+
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/hyprland
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
diff --git a/docs/guide/libraries/mpris.md b/docs/guide/libraries/mpris.md
index 30f3d13..c2283cc 100644
--- a/docs/guide/libraries/mpris.md
+++ b/docs/guide/libraries/mpris.md
@@ -6,52 +6,6 @@ exposing an mpris interface through dbus.
An alternative for [playerctl](https://github.com/altdesktop/playerctl) that better integrates
with astal.
-:::warning
-In order for network cover art urls to be cached (spotify for example)
-make sure `gvfs` is enabled.
-
-:::code-group
-
-```nix [<i class="devicon-nixos-plain"></i> configuration.nix]
-services.gvfs.enable = true;
-```
-
-:::
-
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson vala gvfs json-glib gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson vala valadoc gvfs json-glib-devel gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-sudo apt install meson valac gvfs libjson-glib-dev gobject-introspection
-```
-
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/mpris
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [Mpris reference](https://aylur.github.io/libastal/mpris).
@@ -99,3 +53,49 @@ end
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson vala gvfs json-glib gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson vala valadoc gvfs json-glib-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson valac gvfs libjson-glib-dev gobject-introspection
+```
+
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/mpris
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
+
+:::warning
+In order for network cover art urls to be cached (spotify for example)
+make sure `gvfs` is enabled.
+
+:::code-group
+
+```nix [<i class="devicon-nixos-plain"></i> configuration.nix]
+services.gvfs.enable = true;
+```
+
+:::
diff --git a/docs/guide/libraries/network.md b/docs/guide/libraries/network.md
index 21c7b10..79a217c 100644
--- a/docs/guide/libraries/network.md
+++ b/docs/guide/libraries/network.md
@@ -2,40 +2,6 @@
Wrapper library over [networkmanager](https://networkmanager.dev/) to better integrate with Astal.
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson vala libnm gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson vala valadoc NetworkManager-libnm-devel gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-sudo apt install meson valac libnm-dev gobject-introspection
-```
-
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/network
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [Network reference](https://aylur.github.io/libastal/network).
@@ -81,3 +47,37 @@ print(network.wifi.ssid)
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson vala libnm gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson vala valadoc NetworkManager-libnm-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson valac libnm-dev gobject-introspection
+```
+
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/network
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
diff --git a/docs/guide/libraries/notifd.md b/docs/guide/libraries/notifd.md
index 4208700..1d61099 100644
--- a/docs/guide/libraries/notifd.md
+++ b/docs/guide/libraries/notifd.md
@@ -6,40 +6,6 @@ A [notification daemon](https://specifications.freedesktop.org/notification-spec
The first instantiation of the [Notifd](https://aylur.github.io/libastal/notifd/class.Notifd.html) class will become the daemon and every subsequent instantiation will queue up to act as the daemon and will act as a client in the meantime. This means this library can be used throughout multiple processes.
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson vala gdk-pixbuf2 json-glib gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson vala valadoc gdk-pixbuf2-devel json-glib-devel gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-sudo apt install meson valac libgdk-pixbuf-2.0-dev libjson-glib-dev gobject-introspection
-```
-
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/notifd
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [Notifd reference](https://aylur.github.io/libastal/notifd).
@@ -93,3 +59,37 @@ end
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson vala gdk-pixbuf2 json-glib gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson vala valadoc gdk-pixbuf2-devel json-glib-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson valac libgdk-pixbuf-2.0-dev libjson-glib-dev gobject-introspection
+```
+
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/notifd
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
diff --git a/docs/guide/libraries/powerprofiles.md b/docs/guide/libraries/powerprofiles.md
index bdafcde..b42d7c6 100644
--- a/docs/guide/libraries/powerprofiles.md
+++ b/docs/guide/libraries/powerprofiles.md
@@ -2,45 +2,6 @@
Library and CLI tool for monitoring [upowerd](https://upower.freedesktop.org/) powerprofiles.
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson vala json-glib gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-sudo apt install meson valac libjson-glib-dev gobject-introspection
-```
-
-:::
-
-::: info
-Although UPower is not a direct build dependency,
-it should be self-explanatory that the daemon is required to be available at runtime.
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/powerprofiles
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [PowerProfiles reference](https://aylur.github.io/libastal/powerprofiles).
@@ -84,3 +45,42 @@ print(powerprofiles.active_profile)
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson vala json-glib gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson vala valadoc json-glib-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson valac libjson-glib-dev gobject-introspection
+```
+
+:::
+
+::: info
+Although UPower is not a direct build dependency,
+it should be self-explanatory that the daemon is required to be available at runtime.
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/powerprofiles
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
diff --git a/docs/guide/libraries/references.md b/docs/guide/libraries/references.md
index 3a85d73..f8ab4d8 100644
--- a/docs/guide/libraries/references.md
+++ b/docs/guide/libraries/references.md
@@ -33,6 +33,8 @@ Reading their documentation will vary depending on the language they are used in
- [Auth](https://aylur.github.io/libastal/auth): Authentication library using PAM
- [Battery](https://aylur.github.io/libastal/battery): DBus proxy library for upower daemon
- [Bluetooth](https://aylur.github.io/libastal/bluetooth): Library to control bluez over dbus
+- [Cava](https://aylur.github.io/libastal/cava): Audio visualizer library using cava
+- [Greet](https://aylur.github.io/libastal/greet): Library and CLI tool for sending requests to greetd
- [Hyprland](https://aylur.github.io/libastal/hyprland): Library and cli tool for Hyprland IPC socket
- [Mpris](https://aylur.github.io/libastal/mpris): Library and cli tool for controlling media players
- [Network](https://aylur.github.io/libastal/network): NetworkManager wrapper library
diff --git a/docs/guide/libraries/river.md b/docs/guide/libraries/river.md
index 299aa8c..dc1c71e 100644
--- a/docs/guide/libraries/river.md
+++ b/docs/guide/libraries/river.md
@@ -2,40 +2,6 @@
Library and CLI tool for monitoring the [River Wayland Compositor](https://isaacfreund.com/software/river/).
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson json-glib gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson gcc json-glib-devel gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-sudo apt install meson libjson-glib-dev gobject-introspection
-```
-
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/river
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [River reference](https://aylur.github.io/libastal/river).
@@ -84,3 +50,37 @@ end
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson json-glib gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson gcc json-glib-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson libjson-glib-dev gobject-introspection
+```
+
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/river
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
diff --git a/docs/guide/libraries/tray.md b/docs/guide/libraries/tray.md
index b5cccc7..39dffc1 100644
--- a/docs/guide/libraries/tray.md
+++ b/docs/guide/libraries/tray.md
@@ -2,40 +2,6 @@
Library for managing the systemtray by implementing the [StatusNotifierItem](https://www.freedesktop.org/wiki/Specifications/StatusNotifierItem/) protocol.
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson gtk3 gobject-introspection libdbusmenu-gtk3
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson gcc gtk3-devel libdbusmenu-gtk3 gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-sudo apt install meson libgtk-3-dev libdbusmenu-gtk3-dev gobject-introspection
-```
-
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/tray
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [Tray reference](https://aylur.github.io/libastal/tray).
@@ -84,3 +50,37 @@ end
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson gtk3 gobject-introspection libdbusmenu-gtk3
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson gcc gtk3-devel libdbusmenu-gtk3 gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+sudo apt install meson libgtk-3-dev libdbusmenu-gtk3-dev gobject-introspection
+```
+
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/tray
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```
diff --git a/docs/guide/libraries/wireplumber.md b/docs/guide/libraries/wireplumber.md
index c06161e..d6faea1 100644
--- a/docs/guide/libraries/wireplumber.md
+++ b/docs/guide/libraries/wireplumber.md
@@ -2,40 +2,6 @@
Wrapper library over [wireplumber](https://pipewire.pages.freedesktop.org/wireplumber/) to better integrate with Astal.
-## Installation
-
-1. install dependencies
-
-:::code-group
-
-```sh [<i class="devicon-archlinux-plain"></i> Arch]
-sudo pacman -Syu meson vala wireplumber gobject-introspection
-```
-
-```sh [<i class="devicon-fedora-plain"></i> Fedora]
-sudo dnf install meson vala valadoc wireplumber-devel gobject-introspection-devel
-```
-
-```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
-# Not yet documented
-```
-
-:::
-
-2. clone repo
-
-```sh
-git clone https://github.com/aylur/astal.git
-cd astal/lib/wireplumber
-```
-
-3. install
-
-```sh
-meson setup --prefix /usr build
-meson install -C build
-```
-
## Usage
You can browse the [Wireplumber reference](https://aylur.github.io/libastal/wireplumber).
@@ -81,3 +47,37 @@ print(audio.default_speaker.volume)
```
:::
+
+## Installation
+
+1. install dependencies
+
+:::code-group
+
+```sh [<i class="devicon-archlinux-plain"></i> Arch]
+sudo pacman -Syu meson vala wireplumber gobject-introspection
+```
+
+```sh [<i class="devicon-fedora-plain"></i> Fedora]
+sudo dnf install meson vala valadoc wireplumber-devel gobject-introspection-devel
+```
+
+```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu]
+# Not yet documented
+```
+
+:::
+
+2. clone repo
+
+```sh
+git clone https://github.com/aylur/astal.git
+cd astal/lib/wireplumber
+```
+
+3. install
+
+```sh
+meson setup --prefix /usr build
+meson install -C build
+```