From b14c90d0b512b0539a7f2078a98cfbb1de265a0b Mon Sep 17 00:00:00 2001 From: Tastatur Date: Wed, 16 Aug 2023 23:26:07 +0200 Subject: [PATCH] Converted all Git wiki pages to mkdocs --- docs/void-desktop-setup/Application-launcher.md | 9 +-------- docs/void-desktop-setup/Audio.md | 13 +++---------- docs/void-desktop-setup/Auto-mounting.md | 9 +-------- docs/void-desktop-setup/Display-configuration.md | 9 +-------- docs/void-desktop-setup/Essential-applications.md | 9 +-------- docs/void-desktop-setup/Idle-and-lockscreen.md | 9 +-------- docs/void-desktop-setup/Login-manager.md | 7 ------- docs/void-desktop-setup/Notifications.md | 13 +++---------- docs/void-desktop-setup/Screenshots.md | 9 +-------- docs/void-desktop-setup/Taskbar.md | 7 ------- docs/void-desktop-setup/Window-manager.md | 9 +-------- mkdocs.yml | 14 ++++++++++++++ 12 files changed, 27 insertions(+), 90 deletions(-) diff --git a/docs/void-desktop-setup/Application-launcher.md b/docs/void-desktop-setup/Application-launcher.md index b844edc..a6b3054 100644 --- a/docs/void-desktop-setup/Application-launcher.md +++ b/docs/void-desktop-setup/Application-launcher.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Application launcher - An application launcher may be used to easily start applications in Wayfire. #### Tofi @@ -98,4 +91,4 @@ or ``` # cp {config-files-repo}/polkit/00-power-management.rules /etc/polkit-1/rules.d/ -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Audio.md b/docs/void-desktop-setup/Audio.md index 90b9d7c..c9ec14c 100644 --- a/docs/void-desktop-setup/Audio.md +++ b/docs/void-desktop-setup/Audio.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Audio - To obtain audio the `pipewire` server will be used with an `alsa-pipewire` plugin in combination with `wireplumber` as session manager. They may be installed with: @@ -42,7 +35,7 @@ Pipewire needs to be started by Wayfire. audio = pipewire ``` -#### Audio control +### Audio control To obtain some control over the audio `pavucontrol`, `pamixer` and `pa-notify` may be installed. @@ -69,7 +62,7 @@ To be notified when changing the volume `pa-notify` may be used. It needs to be audio_notify = sleep 1; pa-notify -t 2 ``` -#### Music control +### Music control To control music and other media `playerctl` may be used. @@ -90,4 +83,4 @@ binding_previous = KEY_PREVIOUSSONG command_playpause = playerctl play-pause command_next = playerctl next command_previous = playerctl previous -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Auto-mounting.md b/docs/void-desktop-setup/Auto-mounting.md index 186a1b1..42fae65 100644 --- a/docs/void-desktop-setup/Auto-mounting.md +++ b/docs/void-desktop-setup/Auto-mounting.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Auto-mounting - `udiskie` will be used to automatically mount drives. It may be installed with. ``` @@ -32,4 +25,4 @@ or ``` # cp {config-files-repo}/polkit/00-mounting.rules /etc/polkit-1/rules.d/ -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Display-configuration.md b/docs/void-desktop-setup/Display-configuration.md index 335e3c5..f5787cc 100644 --- a/docs/void-desktop-setup/Display-configuration.md +++ b/docs/void-desktop-setup/Display-configuration.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Display configuration - To configure the displays of the systems it's necessary to either configure them through `.config/wayfire.ini` or use an external application like `kanshi`. To install kanshi: @@ -44,4 +37,4 @@ Add it to Wayfire by auto starting it through: gamma = wlsunset -l -L -t ``` -Change the latitude, longitude and color-temperature according to your location and preference. \ No newline at end of file +Change the latitude, longitude and color-temperature according to your location and preference. diff --git a/docs/void-desktop-setup/Essential-applications.md b/docs/void-desktop-setup/Essential-applications.md index b3251ab..ef719c8 100644 --- a/docs/void-desktop-setup/Essential-applications.md +++ b/docs/void-desktop-setup/Essential-applications.md @@ -1,12 +1,5 @@ ---- -gitea: none -include_toc: false ---- - -### Essential applications - Some essential applications and packages. ``` # xbps-install firefox-esr vscode foot Thunar element-desktop htop mpv blueman wdisplays wlr-randr noto-fonts-ttf noto-fonts-cjk -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Idle-and-lockscreen.md b/docs/void-desktop-setup/Idle-and-lockscreen.md index 9f163d8..f6edc4b 100644 --- a/docs/void-desktop-setup/Idle-and-lockscreen.md +++ b/docs/void-desktop-setup/Idle-and-lockscreen.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Idle and lockscreen - Wayfire has a screensaver and dpms option. These may be configured by editing `.config/wayfire.ini`. ``` @@ -38,4 +31,4 @@ Then, in `.config/wayfire.ini` gtklock may be started with the given conditions: ``` [autostart] idle = swayidle -w timeout 590 gtklock before-sleep gtklock -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Login-manager.md b/docs/void-desktop-setup/Login-manager.md index a396700..a095f3d 100644 --- a/docs/void-desktop-setup/Login-manager.md +++ b/docs/void-desktop-setup/Login-manager.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Login manager - To make it easier to log into the system, set up a login manager. For a minimal and wayland-compatible login manager use `greetd` with `gtkgreet`. Install them with: ``` diff --git a/docs/void-desktop-setup/Notifications.md b/docs/void-desktop-setup/Notifications.md index 78d7637..9e27a89 100644 --- a/docs/void-desktop-setup/Notifications.md +++ b/docs/void-desktop-setup/Notifications.md @@ -1,11 +1,4 @@ ---- -gitea: none -include_toc: false ---- - -### Notifications - -#### SwayNC +### SwayNC For a more robust notification deamon it's recommended to use SwayNotificationCenter which also provides a *notifications center* which can be heavily customised. @@ -56,7 +49,7 @@ And }, ``` -#### Mako +### Mako For a very minimal notification deamon it's recommended to use Mako. It can be used to display notifications from the session-bus. @@ -77,4 +70,4 @@ Mako needs to be started by Wayfire in `.config/wayfire.ini`. ``` [autostart] notifications = mako -``` \ No newline at end of file +``` diff --git a/docs/void-desktop-setup/Screenshots.md b/docs/void-desktop-setup/Screenshots.md index e713586..8af62c3 100644 --- a/docs/void-desktop-setup/Screenshots.md +++ b/docs/void-desktop-setup/Screenshots.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Screenshots - To be able to make screenshots on the system the packages `grim`, `slurp` and `wl-clipboard` will need to be installed. ``` @@ -21,4 +14,4 @@ command_screenshot = grim - | wl-copy -t image/png command_screenshot_interactive = pkill -9 slurp ; grim -g "$(slurp -d)" - | wl-copy -t image/png ``` -Now the *Prt Scn* key will make a screenshot of the entire desktop and *ctrl + super + S* will let you select a region to screenshot. \ No newline at end of file +Now the *Prt Scn* key will make a screenshot of the entire desktop and *ctrl + super + S* will let you select a region to screenshot. diff --git a/docs/void-desktop-setup/Taskbar.md b/docs/void-desktop-setup/Taskbar.md index 89b1c4f..72db1a7 100644 --- a/docs/void-desktop-setup/Taskbar.md +++ b/docs/void-desktop-setup/Taskbar.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Taskbar - For the taskbar it is recommended to use Waybar since it's wayland native and has enough functionality. Furthermore network manager applet will be used to display network status and to easily configure network settings. To install both, in combination with some necessary fonts. diff --git a/docs/void-desktop-setup/Window-manager.md b/docs/void-desktop-setup/Window-manager.md index 3b6244a..06d8a81 100644 --- a/docs/void-desktop-setup/Window-manager.md +++ b/docs/void-desktop-setup/Window-manager.md @@ -1,10 +1,3 @@ ---- -gitea: none -include_toc: false ---- - -### Window manager - There are many different window managers and desktop environments which can provide a decent experience. Wayfire is a functional, relatively lightweight and good looking wayland window manager and will be used for this install. To install a barebones Wayfire use: @@ -31,4 +24,4 @@ A custom bash script may be created in `/usr/local/bin`. That exports all the es ``` # cp -r {config-files-repo}/wayfire/wayfire-run /usr/local/bin/ -``` \ No newline at end of file +``` diff --git a/mkdocs.yml b/mkdocs.yml index b259566..e7c13c5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -33,5 +33,19 @@ nav: - 'Bluetooth': void-desktop-setup/Bluetooth.md - 'Graphical session': - 'Session manager': void-desktop-setup/Session-manager.md + - 'Login manager': void-desktop-setup/Login-manager.md + - 'Window manager': void-desktop-setup/Window-manager.md + - 'Display configuration': void-desktop-setup/Display-configuration.md + - 'Taskbar': void-desktop-setup/Taskbar.md + - 'Application launcher': void-desktop-setup/Application-launcher.md + - 'Notifications': void-desktop-setup/Notifications.md + - 'Audio': void-desktop-setup/Audio.md + - 'Screenshots': void-desktop-setup/Screenshots.md + - 'Idle and lockscreen': void-desktop-setup/Idle-and-lockscreen.md + - 'Auto-mounting': void-desktop-setup/Auto-mounting.md + - 'Applications': + - 'Essential applications': void-desktop-setup/Essential-applications.md + - 'Virt-manager': void-desktop-setup/Virt-manager.md + - 'Steam': void-desktop-setup/Steam.md - 'Alpine Server setup': alpine-home.md - 'Xbps-Ample': ample-home.md