diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 23ac13d0e..9385216d6 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -1,3 +1,141 @@ +const nav = (lang = "", override = {}) => { + let prefix = lang ? `/${lang}` : ""; + return [ + { text: override.home || "Home", link: `${prefix}/` }, + { text: override.about || "About", link: `${prefix}/getting-started/overview` }, + { text: override.showcases || "Showcases", link: `${prefix}/showcases`, activeMatch: `^${prefix}/showcases/` }, + { + text: "2.9.9.2", items: [ + { + text: override.changelog || 'Changelog', + link: 'https://github.com/mylinuxforwork/dotfiles/blob/main/CHANGELOG.md' + }, + ], + }, + { + text: override.more || "More", + items: [ + { + text: 'ML4W Dotfiles Installer', + // we can define like this, see below in sidebar section for more info + // link: '/dots-installer/overview' + link: 'https://mylinuxforwork.github.io/dotfiles-installer/' + }, + { + text: 'ML4W Hyprland Starter', + link: 'https://github.com/mylinuxforwork/hyprland-starter' + }, + { + text: 'Wallpapers', + link: 'https://github.com/mylinuxforwork/wallpaper' + }, + { + text: override["contributing-wiki"] || 'Contributing to wiki →', + link: `${prefix}/development/wiki` + }, + { + text: override.troubleshooting || 'Troubleshooting →', + link: `${prefix}/help/troubleshooting` + }, + ], + }, + ]; +}; + +const sidebar = (lang = "", override = {}) => { + // future feature may be needed: sep sidebar for dots-installer section or any other + // basicallyy when user visits /dots-installer/ page it will only show dots-installer menu items + // just like how vitepress docs sep "refrence" section https://vitepress.dev/ + + // '/dots-installer/': [ + // { + // text: "Dots Installer", + // items: [ + // { text: "Overview", link: "/dots-installer/overview" }, + // { text: "Installation", link: "/dots-installer/installation" }, + // { text: "Dots Installation", link: "/dots-installer/dots-installation" }, + // { text: "Dots File", link: "/dots-installer/dots-file" }, + // ], + // }, + // ], + + const prefix = lang ? `/${lang}` : ""; + + return [ + { + text: override["getting-started"] || "Getting Started", + // collapsed: false, + items: [ + { text: override["getting-started/overview"] || "Overview", link: `${prefix}/getting-started/overview` }, + { text: override["getting-started/installation"] || "Installation", link: `${prefix}/getting-started/install` }, + { text: override["getting-started/launch-hyprland"] || "Launch Hyprland", link: `${prefix}/usage/launch` }, + { text: override["getting-started/update"] || "Update", link: `${prefix}/getting-started/update` }, + { text: override["getting-started/uninstall"] || "Uninstall", link: `${prefix}/getting-started/uninstall` }, + { text: override["getting-started/migration"] || "Migration", link: `${prefix}/getting-started/migrate` }, + { text: override["getting-started/dependencies"] || "Dependencies", link: `${prefix}/getting-started/dependencies` }, + ], + }, + { + text: override["configuration"] || "Configuration", + items: [ + { text: override["configuration/monitor-setup"] || "Monitor Setup", link: `${prefix}/configuration/monitor-setup` }, + { text: override["configuration/input"] || "Keyboard, Mouse, Touchpad", link: `${prefix}/configuration/input` }, + { text: override["customization/shell"] || "Shell", link: `${prefix}/customization/shell` }, + { text: override["customization/terminal"] || "Default Terminal", link: `${prefix}/customization/terminal` }, + { text: override["customization/browser"] || "Default Browser", link: `${prefix}/customization/browser` }, + { text: override["customization/displaymanager"] || "Display Manager", link: `${prefix}/customization/displaymanager` }, + { text: override["configuration/hypr-nvidia"] || "Hyprland + NVIDIA", link: `${prefix}/configuration/hypr-nvidia` }, + { text: override["configuration/xwayland"] || "Switch SDL (X11/Wayland)", link: `${prefix}/configuration/xwayland` }, + { text: override["usage/keybindings"] || "Keybindings", link: `${prefix}/usage/keybindings` }, + { text: override["usage/sidepad"] || "Sidepad", link: `${prefix}/usage/sidepad` }, + { text: override["usage/screenshots"] || "Screenshots", link: `${prefix}/usage/screenshots` }, + { text: override["usage/game-mode"] || "Game Mode", link: `${prefix}/usage/game-mode` }, + ], + }, + { + text: override["customization"] || "Customization", + collapsed: true, + items: [ + { text: override["customization/dotfiles"] || "Dotfiles Customization", link: `${prefix}/customization/dotfiles` }, + { text: override["customization/wallpapers"] || "Wallpapers", link: `${prefix}/usage/wallpapers` }, + { text: override["customization/variants"] || "Config Variants", link: `${prefix}/customization/variants` }, + { text: override["customization/waybar"] || "Customize Waybar", link: `${prefix}/customization/waybar` }, + { text: override["configuration/preserve-config"] || "Preserve your Customization", link: `${prefix}/configuration/preserve-config` }, + ], + }, + { + text: "ML4W Apps", + collapsed: true, + items: [ + { text: override["ml4w-apps/welcome"] || "Welcome App", link: `${prefix}/ml4w-apps/welcome` }, + { text: override["ml4w-apps/sidebar"] || "Sidebar App", link: `${prefix}/ml4w-apps/sidebar` }, + { text: override["ml4w-apps/dotfiles-app"] || "Dotfiles Settings", link: `${prefix}/ml4w-apps/dotfiles-app` }, + { text: override["ml4w-apps/hyprland-app"] || "Hyprland Settings", link: `${prefix}/ml4w-apps/hyprland-app` }, + ], + }, + { + text: override["help"] || "Help", + // collapsed: false, + items: [ + { text: override["help/troubleshooting"] || "Troubleshooting", link: `${prefix}/help/troubleshooting` }, + ], + }, + { + text: override["development"] || "Development", + collapsed: true, + items: [ + { text: override["development/wiki"] || "Contributing to wiki", link: `${prefix}/development/wiki` }, + ] + }, + { + text: override["credentials"] || "Credentials", + items: [ + { text: override["credentials/thankyou"] || "Special Thanks", link: `${prefix}/credentials/thankyou` }, + ] + }, + ] +}; + // .vitepress/config.ts export default { title: 'ML4W Dotfiles for Hyprland Wiki', @@ -10,6 +148,103 @@ export default { ["link", { rel: "icon", href: "ml4w.svg" }], ], + locales: { + root: { + label: "English", + lang: "en-US", + title: 'ML4W Dotfiles for Hyprland Wiki', + description: 'An advanced and full-featured configuration for the dynamic tiling window manager Hyprland', + + themeConfig: { + siteTitle: "ML4W Hyprland Dotfiles ", + logo: "/ml4w.svg", + outline: "deep", + docsDir: "/docs", + editLink: { + pattern: "https://github.com/mylinuxforwork/dotfiles/tree/main/docs/:path", + text: "Edit this page on GitHub", + }, + + nav: nav("", {}), + sidebar: sidebar("", {}), + + returnToTopLabel: 'Go to Top', + sidebarMenuLabel: 'Menu', + }, + }, + + de: { + label: "Deutsch", + lang: "de-DE", + title: 'ML4W Dotfiles für Hyprland Wiki', + description: 'Eine fortschrittliche und voll ausgestattete Konfiguration für den dynamischen Tiling-Window-Manager Hyprland', + + themeConfig: { + siteTitle: "ML4W Hyprland Dotfiles ", + logo: "/ml4w.svg", + outline: "deep", + docsDir: "/docs", + editLink: { + pattern: "https://github.com/mylinuxforwork/dotfiles/tree/main/docs/:path", + text: "Bearbeite diese Seite auf GitHub", + }, + + nav: nav("de", { + home: "Startseite", + about: "Über", + showcases: "Showcases", + more: "Mehr", + changelog: "Änderungsprotokoll", + "contributing-wiki": "Zur Wiki beitragen →", + troubleshooting: "Fehlerbehebung →", + }), + + sidebar: sidebar("de", { + "getting-started": "Erste Schritte", + "getting-started/overview": "Überblick", + "getting-started/installation": "Installation", + "getting-started/launch-hyprland": "Hyprland starten", + "getting-started/update": "Aktualisieren", + "getting-started/uninstall": "Deinstallieren", + "getting-started/migration": "Migration", + "getting-started/dependencies": "Abhängigkeiten", + "configuration": "Konfiguration", + "configuration/monitor-setup": "Monitor-Einrichtung", + "configuration/input": "Tastatur, Maus, Touchpad", + "customization/shell": "Shell", + "customization/terminal": "Standard-Terminal", + "customization/browser": "Standard-Browser", + "customization/displaymanager": "Display Manager", + "configuration/hypr-nvidia": "Hyprland + NVIDIA", + "configuration/xwayland": "Wechsle SDL (X11/Wayland)", + "usage/keybindings": "Tastenkombinationen", + "usage/sidepad": "Sidepad", + "usage/screenshots": "Screenshots", + "usage/game-mode": "Spielmodus", + "customization": "Anpassung", + "customization/dotfiles": "Dotfiles-Anpassung", + "customization/wallpapers": "Hintergrundbilder", + "customization/variants": "Konfigurationsvarianten", + "customization/waybar": "Waybar anpassen", + "configuration/preserve-config": "Bewahre deine Anpassungen", + "ml4w-apps/welcome": "Welcome App", + "ml4w-apps/sidebar": "Sidebar App", + "ml4w-apps/dotfiles-app": "Dotfiles Einstellungen", + "ml4w-apps/hyprland-app": "Hyprland Einstellungen", + "help": "Hilfe", + "help/troubleshooting": "Fehlerbehebung", + "development": "Entwicklung", + "development/wiki": "Zur Wiki beitragen", + "credentials": "Credits", + "credentials/thankyou": "Besonderer Dank", + }), + + returnToTopLabel: 'Gehe zu oben', + sidebarMenuLabel: 'Menü', + }, + }, + }, + themeConfig: { siteTitle: "ML4W Hyprland Dotfiles ", logo: "/ml4w.svg", @@ -19,157 +254,15 @@ export default { pattern: "https://github.com/mylinuxforwork/dotfiles/tree/main/docs/:path", text: "Edit this page on GitHub", }, - nav: [ - { text: "Home", link: "/" }, - { text: "About", link: "/getting-started/overview" }, - { - text: "Showcases", - link: "/showcases", - activeMatch: "/showcases/", - }, - { - text: "2.9.9.4", - items: [ - { - text: 'Changelog', - link: 'https://github.com/mylinuxforwork/dotfiles/blob/main/CHANGELOG.md' - }, - ], - }, - { - text: "More", - items: [ - { - text: 'ML4W Dotfiles Installer', -// we can define like this, see below in sidebar section for more info -// link: '/dots-installer/overview' - link: 'https://mylinuxforwork.github.io/dotfiles-installer/' - }, - { - text: 'ML4W Hyprland Starter', - link: 'https://github.com/mylinuxforwork/hyprland-starter' - }, - { - text: 'Wallpapers', - link: 'https://github.com/mylinuxforwork/wallpaper' - }, - { - text: 'Contributing to wiki →', - link: '/development/wiki' - }, - { - text: 'Troubleshooting →', - link: '/help/troubleshooting' - }, - ], - }, - ], - - sidebar: { - // future feature may be needed: sep sidebar for dots-installer section or any other - // basicallyy when user visits /dots-installer/ page it will only show dots-installer menu items - // just like how vitepress docs sep "refrence" section https://vitepress.dev/ - - // '/dots-installer/': [ - // { - // text: "Dots Installer", - // items: [ - // { text: "Overview", link: "/dots-installer/overview" }, - // { text: "Installation", link: "/dots-installer/installation" }, - // { text: "Dots Installation", link: "/dots-installer/dots-installation" }, - // { text: "Dots File", link: "/dots-installer/dots-file" }, - // ], - // }, - // ], - - // default sidebar '/' that shows for all pages except those with specific sidebar rules above... - - '/': [ - { - text: "Getting Started", - // collapsed: false, - items: [ - { text: "Overview", link: "/getting-started/overview" }, - { text: "Installation", link: "/getting-started/install" }, - { text: "Launch Hyprland", link: "/usage/launch" }, - { text: "Update", link: "/getting-started/update" }, - { text: "Uninstall", link: "/getting-started/uninstall" }, - { text: "Migration", link: "/getting-started/migrate" }, - { text: "Dependencies", link: "/getting-started/dependencies" }, - ], - }, - { - text: "Configuration", - items: [ - { text: "Monitor Setup", link: "/configuration/monitor-setup" }, - { text: "Keyboard, Mouse, Touchpad", link: "/configuration/input" }, - { text: "Shell", link: "/customization/shell" }, - { text: "Default Terminal", link: "/customization/terminal" }, - { text: "Default Browser", link: "/customization/browser" }, - { text: "Display Manager", link: "/customization/displaymanager" }, - { text: "Hyprland + NVIDIA", link: "/configuration/hypr-nvidia" }, - { text: "Switch SDL (X11/Wayland)", link: "/configuration/xwayland" }, - { text: "Keybindings", link: "/usage/keybindings" }, - { text: "Sidepad", link: "/usage/sidepad" }, - { text: "Terminal CLI", link: "/usage/terminal" }, - { text: "Screenshots", link: "/usage/screenshots" }, - { text: "Game Mode", link: "/usage/game-mode" }, - { text: "Activate Walker", link: "/configuration/walker" }, - ], - }, - { - text: "Customization", - collapsed: true, - items: [ - { text: "Dotfiles Customization", link: "/customization/dotfiles" }, - { text: "Wallpapers", link: "/usage/wallpapers" }, - { text: "Global Themes", link: "/usage/themes" }, - { text: "Config Variants", link: "/customization/variants" }, - { text: "Customize Waybar", link: "/customization/waybar" }, - { text: "Preserve your Customization", link: "/configuration/preserve-config" }, - ], - }, - { - text: "ML4W Apps", - collapsed: true, - items: [ - { text: "Welcome App", link: "/ml4w-apps/welcome" }, - { text: "Sidebar App", link: "/ml4w-apps/sidebar" }, - { text: "Dotfiles Settings", link: "/ml4w-apps/dotfiles-app" }, - { text: "Hyprland Settings", link: "/ml4w-apps/hyprland-app" }, - ], - }, - { - text: "Help", - // collapsed: false, - items: [ - { text: "Troubleshooting", link: "/help/troubleshooting" }, - ], - }, - { - text: "Development", - collapsed: true, - items: [ - { text: "Contributing to wiki", link: "development/wiki" }, - ] - }, - { - text: "Credentials", - items: [ - { text: "Special Thanks", link: "credentials/thankyou" }, - ] - }, - ], - }, socialLinks: [ { icon: "discord", link: "https://discord.gg/c4fJK7Za3g" }, { icon: "github", link: "https://github.com/mylinuxforwork" }, - { + { icon: { - svg: 'dots installer' - }, - link: "https://github.com/mylinuxforwork/dotfiles-installer" + svg: 'dots installer' + }, + link: "https://github.com/mylinuxforwork/dotfiles-installer" }, ], @@ -184,8 +277,5 @@ export default { search: { provider: "local", }, - - returnToTopLabel: 'Go to Top', - sidebarMenuLabel: 'Menu', }, }; diff --git a/docs/customization/displaymanager.md b/docs/customization/displaymanager.md index 2b7c92e89..d0ec7b818 100644 --- a/docs/customization/displaymanager.md +++ b/docs/customization/displaymanager.md @@ -125,7 +125,7 @@ sudo vim /etc/sddm.conf The section should look something like this: -```sh +```ini [Theme] Current=Nordic-SDDM ``` @@ -141,7 +141,7 @@ sudo vim /etc/sddm.conf.d/custom-theme.conf ``` Then, add the following content: -```sh +```ini [Theme] Current=Nordic-SDDM ``` diff --git a/docs/de/configuration/hypr-nvidia.md b/docs/de/configuration/hypr-nvidia.md new file mode 100644 index 000000000..221b38db9 --- /dev/null +++ b/docs/de/configuration/hypr-nvidia.md @@ -0,0 +1,23 @@ +# Hyprland und NVIDIA + +> [!WARNING] +> Es gibt keine offizielle Hyprland-Unterstützung für NVIDIA-Hardware. Möglicherweise lässt sich Hyprland jedoch zum Laufen bringen. Siehe dazu: +> https://wiki.hyprland.org/Nvidia/ + +Einige Benutzer berichten, dass Hyprland mit den Dotfiles erfolgreich auf Systemen mit NVIDIA-GPUs unter Verwendung des Open-Source-Treibers "nouveau" installiert werden konnte. + +Alternativ bietet ML4W eine BETA-Option an, um den proprietären NVIDIA-Treiber zu installieren (GRUB-Bootloader erforderlich). +Installiere die Dotfiles mit: + +```sh +ml4w-hyprland-setup -m nvidia +``` + +
+ +**Wähle in der ML4W Settings-App unter System → Environment die [folgende Variation](https://github.com/mylinuxforwork/dotfiles/blob/main/share/dotfiles/.config/hypr/conf/environments/nvidia.conf) aus** + +Oder setze die entsprechenden Umgebungsvariablen direkt in `hyprland.conf`. + +
+ diff --git a/docs/de/configuration/input.md b/docs/de/configuration/input.md new file mode 100644 index 000000000..619bd3fcc --- /dev/null +++ b/docs/de/configuration/input.md @@ -0,0 +1,8 @@ +# Eingabekonfiguration + +Du kannst die Einstellungen für Tastatur, Maus oder Touchpad jederzeit in dieser Datei ändern: + +`./config/hypr/conf/keyboard.conf` + +Deine Eingabekonfiguration kann bei jedem Update der Dotfiles wiederhergestellt werden. + diff --git a/docs/de/configuration/monitor-setup.md b/docs/de/configuration/monitor-setup.md new file mode 100644 index 000000000..0bd243b22 --- /dev/null +++ b/docs/de/configuration/monitor-setup.md @@ -0,0 +1,45 @@ +# Monitor-Einrichtung + +Wenn du die Standard-Monitor-Konfiguration ändern möchtest, kannst du entweder eine persönliche Monitor-Variation anlegen oder `nwg-displays` verwenden. + +## Persönliche Monitor-Variation + +Öffne die ML4W Dotfiles Settings App und wähle den Reiter "System". Beim Herunterscrollen findest du die mitgelieferten Monitor-Variationen. + +![image](/monitor.png) + +Du kannst auch eine eigene Variation erstellen, wie in der Dokumentation beschrieben: [Configuration-Variations](https://github.com/mylinuxforwork/dotfiles/wiki/Configuration-Variations). + +## Verwendung von nwg-displays + +Die ML4W Dotfiles unterstützen die Anwendung [nwg-displays](https://github.com/nwg-piotr/nwg-displays) zur Konfiguration deiner Anzeigeeinstellungen. + +Installiere `nwg-displays` für deine Distribution wie folgt: + +::: code-group + +```sh [ Arch] +sudo pacman -S nwg-displays +``` + +```sh [ Fedora] +sudo dnf install python-build python-installer python-wheel python-setuptools +git clone https://github.com/nwg-piotr/nwg-displays ~/nwg-displays +cd ~/nwg-displays && chmod +x install.sh +sudo ./install.sh +``` +```sh [ openSuse] +sudo zypper install nwg-displays +``` + +::: + +Öffne die App und wende deine gewünschten Monitoreinstellungen an. + +![image](/monitor1.png) + +Anschließend öffne die ML4W Settings App und wähle die Monitor-Variation `nwg-displays`. + +![image](/monitor2.png) + +> Ab jetzt kannst du deine Monitoreinstellungen direkt in `nwg-displays` ändern. diff --git a/docs/de/configuration/preserve-config.md b/docs/de/configuration/preserve-config.md new file mode 100644 index 000000000..0f0bc2432 --- /dev/null +++ b/docs/de/configuration/preserve-config.md @@ -0,0 +1,10 @@ +# Bewahre deine Anpassungen + +> [!NOTE] +> Der Dotfiles Installer installiert die Dotfiles standardmäßig in `.mydotfiles`. Du kannst den Zielordner in den Einstellungen anpassen. + +## Schütze Ordner in `.config` mit dem Dotfiles Installer + +Wenn du deine aktuellen ML4W-Dotfiles mit dem Dotfiles Installer auf eine neue Version aktualisierst, kannst du Konfigurationsordner oder -dateien im Ordner `.config` mit deinen Anpassungen schützen. Der Dotfiles Installer merkt sich deine Auswahl für zukünftige Updates. + +![image](https://mylinuxforwork.github.io/dotfiles-installer/protectscreen.jpg) diff --git a/docs/de/configuration/xwayland.md b/docs/de/configuration/xwayland.md new file mode 100644 index 000000000..9462f9600 --- /dev/null +++ b/docs/de/configuration/xwayland.md @@ -0,0 +1,34 @@ +# SDL umschalten + +Einige Spiele verwenden veraltete SDL-Versionen, die ohne Wayland-Unterstützung kompiliert wurden. Das bedeutet, dass sie wahrscheinlich nicht starten (oder beim Start abstürzen), wenn `SDL_VIDEODRIVER` auf `wayland` gesetzt ist.** + +Du kannst zwischen Wayland und X11 in der Datei `~/dotfiles/hypr/conf/custom.conf` wechseln: + +```sh +# SDL-Version +env = SDL_VIDEODRIVER,wayland +# env = SDL_VIDEODRIVER,x11 +``` + +> [!NOTE] +> In Versionen vor 2.9.5RL findest du den Eintrag in `~/dotfiles/hypr/conf/ml4w.conf` + +## Toolkit-Backend Umgebungsvariablen + +Diese Umgebungsvariablen stellen sicher, dass die richtigen Backends in Hyprland verwendet werden: + +| Variable | Wert | +|----------|------| +| `GDK_BACKEND` | `wayland,x11,*` | +| `SDL_VIDEODRIVER` | `wayland` | +| `CLUTTER_BACKEND` | `wayland` | + +> [!TIP] +> Verschiebe die folgende Zeile in deine `custom.conf`, um mehr Kontrolle zu haben: +> +> ```ini +> env = SDL_VIDEODRIVER,wayland +> ``` + + + diff --git a/docs/de/credentials/thankyou.md b/docs/de/credentials/thankyou.md new file mode 100644 index 000000000..34b3012bb --- /dev/null +++ b/docs/de/credentials/thankyou.md @@ -0,0 +1,25 @@ +# Besonderer Dank + +Ich möchte allen Mitwirkenden der ML4W-Dotfiles und allen Entwicklern danken, die großartige Konfigurationen für unseren Lieblings-Tiling-Fenstermanager Hyprland erstellen. Eure Unterstützung, das Testen jeder Version und all eure wertvollen Pull Requests mit Verbesserungen und Fehlerbehebungen haben das Projekt wiederholt verbessert und seine Qualität gesteigert. + +Besonderer Dank geht an: + +https://github.com/harilvfs für die Unterstützung beim Erstellen des neuen Wikis https://mylinuxforwork.github.io/dotfiles/ + +https://github.com/Mat-Armstrong für das neue ML4W-Logo-Design und vieles mehr. + +https://github.com/dwilliam62 für all deine Unterstützung und Tests seit Beginn des Projekts + +und so viele mehr... + +Die folgenden Projekte haben mich inspiriert: + +- https://github.com/JaKooLit/Hyprland-Dots +- https://github.com/prasanthrangan/hyprdots +- https://github.com/sudo-harun/dotfiles +- https://github.com/dianaw353/hyprland-configuration-rootfs +- https://github.com/basecamp/omarchy + +und viele weitere... + +Und natürlich https://github.com/vaxerski für diese großartige Software. \ No newline at end of file diff --git a/docs/de/customization/browser.md b/docs/de/customization/browser.md new file mode 100644 index 000000000..74138f763 --- /dev/null +++ b/docs/de/customization/browser.md @@ -0,0 +1,25 @@ +# Default Browser + +
+ +**Der Standardbrowser ist Firefox. Du kannst aber jeden beliebigen Browser als Standard setzen.** + +
+ +As an example, let's install brave. + +```sh +yay -S brave-bin +``` + +Öffne anschließend die ML4W Dotfiles Settings App mit `SUPER+CTRL+S`, wähle den Reiter Waybar, scrolle nach unten und ändere den Browser auf `brave`. + +![image](/browser.png) + +Führe dann folgenden Befehl in einem Terminal aus: + +```sh +xdg-settings set default-web-browser brave.desktop +``` + +Um den Waybar-Quicklink für den Browser zu ändern, folge den Anweisungen im Abschnitt `Customize Waybar`. diff --git a/docs/de/customization/displaymanager.md b/docs/de/customization/displaymanager.md new file mode 100644 index 000000000..c5d9bfc73 --- /dev/null +++ b/docs/de/customization/displaymanager.md @@ -0,0 +1,182 @@ + +# Display Manager + +Dieses Tutorial führt dich durch die Installation eines Display Managers wie SDDM und das Wechseln zwischen verschiedenen Display Managern (z. B. SDDM und GDM) auf einem Linux-System. Display Manager bieten eine grafische Anmeldemaske und verwalten Benutzersitzungen. + +> [!NOTE] +> Die ML4W Dotfiles enthalten keine Display-Manager-Konfiguration, um nicht direkt sensible Systemkomponenten wie Display Manager zu manipulieren. + +Aktualisiere zuerst deine Paketliste, bevor du einen Display Manager installierst. + +::: code-group + +```sh [Arch] +sudo pacman -Syu +``` + +```sh [Fedora] +sudo dnf update +``` + +```sh [openSuze] +sudo zypper update +``` +::: + +## SDDM + +### SDDM für deine Distribution installieren: + +::: code-group + +```sh [Arch] +sudo pacman -S sddm +``` + +```sh [Fedora] +sudo dnf install sddm +``` + +```sh [openSuze] +sudo zypper install sddm +``` +::: + + +### SDDM aktivieren (falls nicht automatisch aktiviert) + +Während der Installation kann es sein, dass einige Distributionen dich auffordern, den Standard-Display-Manager auszuwählen. Falls nicht, oder wenn du ihn explizit aktivieren möchtest, kannst du dies tun. + +Für Systeme mit systemd (die meisten modernen Distributionen): + +```sh +sudo systemctl enable sddm +``` + +Wenn zuvor ein anderer Display Manager (z. B. GDM) aktiviert war, deaktiviert das Aktivieren von SDDM diesen in der Regel automatisch. Wenn du sicher gehen möchtest, kannst du den alten explizit deaktivieren (z. B. GDM): + +```sh +sudo systemctl disable gdm # Nur falls GDM zuvor aktiviert war +``` +### SDDM-Themes installieren + +Die Installation eines SDDM-Themes hängt vom jeweiligen Theme-Entwickler ab. Viele großartige SDDM-Themes findest du auf Gnome Look: https://www.gnome-look.org/browse?cat=101&ord=top + +Die Installation eines benutzerdefinierten SDDM-Themes umfasst in der Regel das Herunterladen des Themes, Entpacken, Verschieben in das richtige Verzeichnis und das Konfigurieren von SDDM. + + +#### Schritt 1: Theme herunterladen + +1. Öffne deinen Webbrowser und gehe zur Theme-Seite: https://www.gnome-look.org/p/1312658 +2. Navigiere zum Reiter "Files" auf der Theme-Seite. +3. Lade die neueste Version des Themes herunter (meist ein .tar.gz oder .zip). Für das "Nordic"-Theme suche nach einer Datei wie Nordic-SDDM.tar.gz. + +> [!TIP] +> Merke dir, wo die Datei gespeichert wird (z. B. dein Downloads-Ordner). + +#### Schritt 2: Theme entpacken + +1. Öffne ein Terminal. +2. Wechsle in das Verzeichnis, in das du das Theme heruntergeladen hast. Beispiel: + +```sh +cd ~/Downloads +``` +3. Entpacke das heruntergeladene Archiv. + +Wenn es eine .tar.gz-Datei ist: + +```sh +tar -xvf Nordic-SDDM.tar.gz +``` + +Wenn es eine .zip-Datei ist: + +```sh +unzip Nordic-SDDM.zip +``` +Dies erstellt ein neues Verzeichnis (z. B. Nordic-SDDM oder Nordic) mit den Theme-Dateien. + +#### Schritt 3: Theme in das SDDM-Themes-Verzeichnis verschieben + +SDDM-Themes liegen typischerweise in `/usr/share/sddm/themes/`. Du benötigst `sudo`, um Dateien in dieses Verzeichnis zu verschieben. + +Verschiebe das entpackte Theme-Verzeichnis in das SDDM-Themes-Verzeichnis. Ersetze `Nordic-SDDM` durch den tatsächlichen Verzeichnisnamen. + +```sh +sudo mv Nordic-SDDM /usr/share/sddm/themes/ +``` +> [!NOTE] +> Achte darauf, das gesamte Theme-Verzeichnis (nicht nur dessen Inhalt) nach `/usr/share/sddm/themes/` zu verschieben. + +#### Schritt 4: SDDM konfigurieren, damit es das neue Theme verwendet + +Bearbeite die SDDM-Konfigurationsdatei und setze das Theme (z. B. `/etc/sddm.conf` oder eine Datei unter `/etc/sddm.conf.d/`). + +```sh +sudo vim /etc/sddm.conf +``` + +1. Finde den Abschnitt `[Theme]` oder füge ihn hinzu. +2. Setze `Current=` auf den Namen des Theme-Ordners, z. B.: + +```ini +[Theme] +Current=Nordic-SDDM +``` + +3. Speichere und beende den Editor. + +Alternative: Lege eine Datei unter `/etc/sddm.conf.d/` an, falls `/etc/sddm.conf` nicht vorhanden ist. + +```sh +sudo vim /etc/sddm.conf.d/custom-theme.conf +``` + +Füge dann den Abschnitt hinzu: + +```ini +[Theme] +Current=Nordic-SDDM +``` + +#### Schritt 5: Änderungen anwenden + +Starte den SDDM-Dienst neu: + +```sh +sudo systemctl restart sddm +``` +> [!WARNING] +> Dieser Befehl bringt dich sofort zurück zum Login-Bildschirm. Speichere vorher alle offenen Arbeiten. + +Nach dem Neustart solltest du das neue SDDM-Theme sehen. Bei Problemen überprüfe Verzeichnisnamen und die `Current=`-Einstellung auf Tippfehler. + +## Zwischen Display Managern wechseln + +Die meisten Distributionen bieten einfache Möglichkeiten, zwischen installierten Display Managern zu wechseln. Beispiel: + +SDDM deaktivieren: + +```sh +sudo systemctl disable sddm +``` + +GDM aktivieren: + +```sh +sudo systemctl enable gdm # oder gdm3 +``` + +SDDM stoppen und GDM starten (optional): + +```sh +sudo systemctl stop sddm +sudo systemctl start gdm # oder gdm3 +``` + +System neu starten: + +```sh +sudo reboot +``` diff --git a/docs/de/customization/dotfiles.md b/docs/de/customization/dotfiles.md new file mode 100644 index 000000000..f230a7e72 --- /dev/null +++ b/docs/de/customization/dotfiles.md @@ -0,0 +1,40 @@ +# Übersicht + +Die ML4W-Dotfiles lassen sich auf verschiedene Weise an persönliche Vorlieben anpassen. + +Der einfachste Weg ist die Nutzung der mitgelieferten ML4W-Apps. Klicke auf das ML4W-Logo in der oberen rechten Ecke der Statusleiste, um die Seitenleiste mit den Icons der drei Apps zu öffnen. + +
+ +![image](/sidebar.jpg) + +
+ +## ML4W Welcome App + +![image](/welcome.jpg) + +Die ML4W Welcome App ist ein zentraler Zugriffspunkt für grundlegende Systemeinstellungen. + +## ML4W Dotfiles Settings App + +![image](/cs2.png) + +Die ML4W Dotfiles Settings App ermöglicht den Zugriff auf Waybar-Einstellungen (z. B. Zeit-/Datumsformat), das Ein- und Ausschalten verschiedener Waybar-Module und das Erhöhen der Anzahl von Workspaces. Unter "Appearance" kannst du die Position des Notification-Daemons (dunst), einige rofi-Einstellungen, Blur-Effekte sowie Variationen für Animationen und Fenster definieren. Im Abschnitt "Wallpaper" kannst du den Wallpaper-Effekt einstellen und den Wallpaper-Cache leeren. Unter "System" legst du Standard-Anwendungen, Leerlaufzeiten, den Monitor, Keybindings und UmgebungsvariablenTipp mit Konfigurationsvariationen fest. Du kannst die mitgelieferten Variationen leicht mit eigenen anpassen. + +## ML4W Hyprland Settings App + +![image](/hyprland-settings.jpg) + +Die ML4W Hyprland App erlaubt dir, nahezu alle Hyprland-Variablen anzupassen: Fensterrahmen, Gaps, Blur-Einstellungen, Schatten und vieles mehr. + +## Waybar-Themes + +Die ML4W-Dotfiles enthalten eine Auswahl an Themes für die Statusleiste Waybar. Du kannst außerdem eigene Themes anhand des Waybar Starter-Themes hinzufügen. + +## Nutzung der `custom.conf` + +![image](/cs4.png) + +Wenn du die Hyprland-Konfiguration direkt erweitern möchtest (z. B. um einen weiteren Autostart-Befehl oder Umgebungsvariablen hinzuzufügen), kannst du die `custom.conf` unter `~/.config/hypr/conf/custom.conf` bearbeiten. Die `custom.conf` kann bei Updates wiederhergestellt werden. Du kannst die `custom.conf` über die ML4W Dotfiles Settings App öffnen. + diff --git a/docs/de/customization/shell.md b/docs/de/customization/shell.md new file mode 100644 index 000000000..ca6918fe0 --- /dev/null +++ b/docs/de/customization/shell.md @@ -0,0 +1,88 @@ +# Shell (Bash, ZSH, Fish) + +Die ML4W-Dotfiles für Hyprland werden mit vorkonfigurierten Einstellungen für `bash`, `zsh` und `fish` ausgeliefert. Du kannst die Shell über die ML4W Welcome App ändern: Settings → System → Change Shell. + +![image](/change-shell.jpg) + +## `.zshrc` anpassen + +Wenn du zusätzliche Einstellungen für `zsh` einbringen möchtest, erstelle eine Datei `.zshrc_custom` in deinem Home-Verzeichnis. + +Für komplexere Anpassungen hast du folgende Möglichkeiten. + +Die `.zshrc` lädt die Dateien aus dem Ordner `~/.config/zshrc` in dieser Reihenfolge: + +* 00-init +* 10-aliases +* 20-customization +* 30-autostart + +Du kannst eine eigene Datei in die Lade-Reihenfolge einfügen. Willst du z. B. nach `20-customization` eine Datei laden, erstelle `25-my-additions`. + +Wenn du eine mitgelieferte Datei überschreiben möchtest, kopiere sie in den Unterordner `custom` mit demselben Dateinamen und nehme deine Anpassungen vor (z. B. um zusätzliche `oh-my-posh`-Plugins hinzuzufügen). + +Deine Anpassungen sind gegen ML4W-Updates geschützt. + +### oh-my-zsh + +Die `zsh`-Konfiguration basiert auf `oh-my-zsh` zur Verwaltung von Plugins und `oh-my-posh` für das Prompt. Folgende Plugins sind installiert: + +```sh +plugins=( + git + sudo + web-search + archlinux + zsh-autosuggestions + zsh-syntax-highlighting + fast-syntax-highlighting + copyfile + copybuffer + dirhistory +) +``` +### FZF + +Die Tastenkombination für FZF ist `CTRL + R` für die fuzzy History-Suche. + +### oh-my-posh + +Das Prompt basiert auf `oh-my-posh` und der großartigen, minimalen "zen"-Konfiguration von **Dreams of Autonomy**. + + + +Wenn du ein eigenes Theme erstellen möchtest, speichere die Konfiguration in `~/.config/ohmyposh` und verlinke sie z. B. so: + +```sh +# ----------------------------------------------------- +# oh-my-posh prompt +# ----------------------------------------------------- +# Custom Theme +eval "$(oh-my-posh init zsh --config $HOME/.config/ohmyposh/zen.toml)" +``` + +Alternativ kannst du ein mitgeliefertes `oh-my-posh`-Theme aktivieren: + +```sh +# Shipped Theme +eval "$(oh-my-posh init zsh --config /usr/share/oh-my-posh/themes/agnoster.omp.json)" +``` + +## `.bashrc` anpassen + +Für `bash` gilt ein ähnliches Vorgehen: Erstelle `~/.bashrc_custom`, wenn du zusätzliche Einstellungen einbringen möchtest. + +Die `.bashrc` lädt Dateien aus `~/.config/bashrc` in dieser Reihenfolge: + +* 00-init +* 10-aliases +* 20-customization +* 30-autostart + +Auch hier kannst du eigene Dateien in die Reihenfolge einfügen (z. B. `25-my-additions`) oder mitgelieferte Dateien im `custom`-Ordner überschreiben. + +Deine Anpassungen sind gegen ML4W-Updates geschützt. + diff --git a/docs/de/customization/terminal.md b/docs/de/customization/terminal.md new file mode 100644 index 000000000..381f0c0ad --- /dev/null +++ b/docs/de/customization/terminal.md @@ -0,0 +1,14 @@ +# Standard-Terminal + +
+ +**Öffne die ML4W Dotfiles Settings App und wähle den Reiter "System".** + +
+ +![image](/terminal.png) + +Ersetze `alacritty` durch `kitty` und speichere die Änderung. + +Ab jetzt öffnet sich `kitty` mit `SUPER + Return`, beim Klicken auf das Modul für Paketupdates oder das Netzwerkmodul. + diff --git a/docs/de/customization/variants.md b/docs/de/customization/variants.md new file mode 100644 index 000000000..6a5416912 --- /dev/null +++ b/docs/de/customization/variants.md @@ -0,0 +1,45 @@ +# Konfigurationsvarianten + +Mit Konfigurationsvarianten kannst du verschiedene Einstellungen für deine Hyprland-Installation vorbereiten. + +![Screenshot](/config-var.png) + +## Nutzung von Konfigurationsvarianten + +Öffne die ML4W Dotfiles Settings App über die ML4W Welcome App, den App-Launcher oder das Zahnrad-Icon in Waybar. + +Du findest mehrere Varianten in den drei Einstellungsseiten: + +- Monitor (Screen Resolutions) +- Animations +- Keybindings +- Windows +- Window Rules +- Decorations +- Environments +- Layout + +Wähle die gewünschte Variante aus dem entsprechenden Dropdown-Menü. + +Bitte bearbeite nicht die mitgelieferten Variationen, da sie bei jedem Update überschrieben werden. Erstelle stattdessen deine eigene Custom-Variation. + +## Eigene Variation erstellen + +Öffne die ML4W Dotfiles Settings App und wähle im Kontextmenü der Variante "Open Variation Folder". + +![Screenshot](/var2.png) + +Kopiere eine vorhandene Variante als Ausgangspunkt und benenne die neue Datei entsprechend um. + +![Screenshot](/var3.png) + +Bearbeite die Konfiguration deiner neuen Variante und speichere sie. + +Gehe zurück zur Settings App, wähle im Kontextmenü "Reload Variations" und aktiviere deine neue Variante. + +![Screenshot](/var4.png) + +Du kannst die Variante auch direkt in der Settings App bearbeiten. + +![Screenshot](/var5.png) + diff --git a/docs/de/customization/waybar.md b/docs/de/customization/waybar.md new file mode 100644 index 000000000..29233519c --- /dev/null +++ b/docs/de/customization/waybar.md @@ -0,0 +1,145 @@ +Die Statusleiste der ML4W Dotfiles ist **Waybar**. Die Waybar-Konfiguration befindet sich in `~/dotfiles/waybar`. + +### Waybar-Tastenkürzel + +| Tastenkürzel | Aktion | +|--------|--------| +| SUPER + CTRL + B | Waybar umschalten | +| SUPER + SHIFT + B | Waybar-Theme neu laden | +| SUPER + CTRL + T | Waybar-Theme mit themeswitcher wechseln | +| SUPER + CTRL + T | Rofi-themeswitcher für Waybar öffnen | + +## Waybar-Themes und themeswitcher + +| Theme auswählen | +|-----------------| +| Verwende SUPER + CTRL + T (custom Hyprland key binding), um das Skript `themeswitcher.sh` auszuführen. Das Skript öffnet Rofi und zeigt Themes in `~/.config/waybar/themes/`. | + +## Quicklinks definieren + +Die Waybar enthält einen Bereich für Quicklinks. + +![image](/bar.png) + +Die Icons für ChatGPT und Settings sind fest. Alle anderen Icons kannst du in `~/.config/ml4w/settings/waybar-quicklinks.json` anpassen oder erweitern. + +In der JSON-Datei kannst du bis zu 10 Quicklinks definieren und zur Quicklinks-Gruppe in Waybar hinzufügen: +https://github.com/mylinuxforwork/dotfiles/blob/main/share/dotfiles/.config/ml4w/settings/waybar-quicklinks.json + +```sh +/* +Define your quick links for the statusbar here. +YOu can use icons from here https://fontawesome.com/search?ic=free +You can reload waybar with SUPER + SHIFT + B +*/ +{ + "custom/quicklink_browser": { + "format": "", + "on-click": "~/.config/ml4w/settings/browser.sh", + "tooltip-format": "Open Browser" + }, + "custom/quicklink_filemanager": { + "format": "", + "on-click": "~/.config/ml4w/settings/filemanager.sh", + "tooltip-format": "Open Filemanager" + }, + "custom/quicklink_email": { + "format": "", + "on-click": "~/.config/ml4w/settings/filemanager.sh", + "tooltip-format": "Open Email Client" + }, + "custom/quicklink_chromium": { + "format": "", + "on-click": "chromium", + "tooltip-format": "Open Chromium" + }, + "custom/quicklink_edge": { + "format": "", + "on-click": "edge", + "tooltip-format": "Open Edge" + }, + "custom/quicklink_firefox": { + "format": "", + "on-click": "firefox", + "tooltip-format": "Open Firefox" + }, + "custom/quicklink_thunderbird": { + "format": "", + "on-click": "thunderbird", + "tooltip-format": "Open Thunderbird" + }, + "custom/quicklink_calculator": { + "format": "", + "on-click": "~/.config/ml4w/settings/calculator.sh", + "tooltip-format": "Open calculator" + }, +/* +Don't remove the quicklinkempty +*/ + "custom/quicklinkempty": { + }, +/* +Add your quicklinks in your desired order to the status bar +*/ + "group/quicklinks": { + "orientation": "horizontal", + "modules": [ + + "custom/quicklink_browser", + "custom/quicklink_email", + "custom/quicklink_filemanager", + +/* +Don't remove the quicklinkempty +*/ + "custom/quicklinkempty" + ] + } +} +``` +Diese Konfiguration enthält bereits einen vorbereiteten Quicklink für Firefox inkl. des passenden Symbols. Aktiviere ihn, indem du die Kommentar-Markierungen entfernst und Chromium entfernst. + +| Nach Änderungen neu laden | +|--------------------------| +| Nach Änderungen an der Datei lade Waybar mit `SUPER` + `SHIFT` + `B` neu. | + +Free Icons von Font Awesome findest du auf [fontawesome.com](https://fontawesome.com/search?o=r&m=free) + +## Eigene `config` und `style.css` für ein ML4W-Theme + +Wenn du Module aus den ML4W-Themes ausblenden oder das Styling anpassen möchtest, erstelle eine Kopie der Konfigurationsdatei mit dem Namen `config-custom` oder eine Kopie von `style.css` namens `style-custom.css`. + +Der Waybar-Loader verwendet dann deine Kopien anstelle der Standarddateien. + +Mit einer persönlichen `config-custom` kannst du auch eine eigene `modules.json` mit zusätzlichen Modulen laden. + +## Eigenes Theme vom Starter-Theme ableiten + +Prüfe die Konfigurationen in `~/dotfiles/waybar/themes/`. + +Ein guter Startpunkt ist das Waybar Starter-Theme. + +Kopiere den Ordner `~/.config/waybar/themes/starter` und benenne die Kopie z. B. in `mytheme` um. + +Öffne die Datei `~/.config/waybar/themes/mytheme/config.sh` und gib deinem Theme einen Namen: + +```sh +#!/bin/bash +theme_name="MyTheme" +``` + +| Theme auswählen | +|-----------------| +| Wähle dein Theme, indem du auf das "..."-Icon in Waybar klickst oder `SUPER` + `CTRL` + `T` verwendest. | + +Um dein Theme anzupassen, kannst du `config`, `style.css` und `modules.json` bearbeiten. + +| Theme neu laden | +|-----------------| +| Du kannst das Waybar-Theme mit `SUPER` + `SHIFT` + `B` neu laden. | + +## Waybar Dokumentation + +- Waybar configuration: https://github.com/Alexays/Waybar/wiki/Configuration +- Waybar Styling: https://github.com/Alexays/Waybar/wiki/Styling + diff --git a/docs/de/development/wiki.md b/docs/de/development/wiki.md new file mode 100644 index 000000000..7bba250a5 --- /dev/null +++ b/docs/de/development/wiki.md @@ -0,0 +1,87 @@ +# Zur Mitwirkung am Wiki + +Dieses Wiki wurde mit [VitePress](https://vitepress.dev/) erstellt. + +Die Wiki-Dateien findest du im Repository [ml4w dotfiles](https://github.com/mylinuxforwork/dotfiles). + +Wenn du beitragen möchtest: Forke das Repo, nimm deine Änderungen vor und öffne einen Pull Request. + +## Docs lokal bauen + +Installiere `bun` von der offiziellen Seite: https://bun.sh + +Abhängigkeiten installieren: + +```sh +bun install +``` + +VitePress als Dev-Abhängigkeit hinzufügen (falls nötig): + +```sh +bun add -D vitepress +``` + +Dev-Server starten, um Änderungen live zu sehen: + +```sh +bun run docs:dev +``` + +Build testen: + +```sh +bun run docs:build +``` + +Vorschau: + +```sh +bun run docs:preview +``` + +Stelle sicher, dass deine Änderungen keine Fehler einführen. Teste alles lokal, bevor du einen PR öffnest. + +## Richtlinien + +Wenn deine Änderungen Inhalte hinzufügen (z. B. eine neue Anleitung), achte auf Genauigkeit und klare, saubere Markdown-Formatierung. + +Wir bitten außerdem, keine kompletten Umschreibungen oder vollständige Texte ausschließlich durch LLMs erstellen zu lassen. + +Bitte vermeide `em dashes` in den Docs. + +> Unsere Devise: sauber & minimal also bitte halte dich an diese Richtlinien. + +## Mehrsprachigkeit + +> [!WARNING] +> +> Dokumentationen in anderen Sprachen als Englisch sind möglicherweise nicht aktuell. Überprüfe das angezeigte Datum und die angezeigte ml4w-Version und ziehe im Zweifel die englische Dokumentation zu Rate. + +> [!NOTE] +> Letzte Aktualisierung: 21. September 2025 +> Basierend auf ml4w Version: 2.9.9.2 + +**Um eine neue Sprache hinzuzufügen, gehe wie folgt vor:** + +1. Erstelle einen Ordner mit dem Sprachcode (z. B. `docs/de/`) und lege dort die übersetzten Markdown-Dateien ab. +2. Füge die Locale in `.vitepress/config.ts` hinzu. Minimalbeispiel: + +```ts +// .vitepress/config.ts +export default { + locales: { + de: { + label: "Deutsch", + lang: "de-DE", + title: 'ML4W Dotfiles für Hyprland Wiki', + description: 'Eine fortschrittliche und voll ausgestattete Konfiguration für den dynamischen Tiling-Window-Manager Hyprland', + } + } +} +``` + +3. Stelle sicher, dass Routen und Navigation das Sprachpräfix (z. B. `/de/`) verwenden, und passe interne Links entsprechend an. +4. Gib in diesem Abschnitt das Datum und die ml4w-Version an, die der letzten Änderung der Dokumentation in dieser Sprache entsprechen. + +> Danke für deine Unterstützung. diff --git a/docs/de/getting-started/dependencies.md b/docs/de/getting-started/dependencies.md new file mode 100644 index 000000000..432668d2b --- /dev/null +++ b/docs/de/getting-started/dependencies.md @@ -0,0 +1,76 @@ +# Dependencies + +Du kannst die ML4W-Dotfiles für Hyprland auf jeder Linux-Distribution installieren, wenn du zuvor die folgenden Pakete installierst. + +> [!NOTE] +> Die Paketnamen können je nach Distribution unterschiedlich sein. + +```sh +wget +unzip +gum +rsync +git +figlet +xdg-user-dirs +hyprland +hyprpaper +hyprlock +hypridle +hyprpicker +xdg-desktop-portal-gtk +xdg-desktop-portal-hyprland +libnotify +kitty +qt5-wayland +qt6-wayland +fastfetch +eza +python-pip +python-gobject +python-screeninfo +tumbler +brightnessctl +nm-connection-editor +network-manager-applet +imagemagick +jq +xclip +kitty +neovim +htop +blueman +grim +slurp +cliphist +nwg-look +qt6ct +waybar +rofi-wayland +polkit-gnome +zsh +zsh-completions +fzf +pavucontrol +papirus-icon-theme +breeze +flatpak +swaync +gvfs +wlogout +waypaper +grimblast-git +bibata-cursor-theme +pacseek +otf-font-awesome +ttf-fira-sans +ttf-fira-code +ttf-firacode-nerd +nwg-dock-hyprland +power-profiles-daemon +python-pywalfox +vlc + +``` + +Nach der Installation der Abhängigkeiten kannst du die Dotfiles mit dem Dotfiles Installer installieren. \ No newline at end of file diff --git a/docs/de/getting-started/install.md b/docs/de/getting-started/install.md new file mode 100644 index 000000000..45959146b --- /dev/null +++ b/docs/de/getting-started/install.md @@ -0,0 +1,113 @@ +# Installation + +## Installation mit dem Dotfiles Installer + +::: warning VORAB +Bitte sichere deinen bestehenden `~/.config`-Ordner, bevor du die Skripte für die Erstinstallation ausführst. +::: + +Du kannst die ML4W Dotfiles für Hyprland auf jeder Distribution mit dem Dotfiles Installer aus Flathub installieren. Klicke auf das Badge, um die App zu installieren: + + + +::: warning VORAB +Der Dotfiles Installer erstellt ein Backup der Konfigurationen in deinem `.config`-Ordner, die durch die Installation überschrieben werden könnten. + +Falls möglich, erstelle bitte zusätzlich einen System-Snapshot (z. B. mit snapper oder Timeshift). +::: + +Kopiere die folgende URL in den Dotfiles Installer. + +#### Stabile Version + +```sh +https://raw.githubusercontent.com/mylinuxforwork/dotfiles/main/hyprland-dotfiles-stable.dotinst +``` +#### Rolling-Version + +```sh +https://raw.githubusercontent.com/mylinuxforwork/dotfiles/main/hyprland-dotfiles.dotinst +``` + +Installationsskripte zur Einrichtung der benötigten Abhängigkeiten sind für Arch, Fedora und openSuse Tumbleweed enthalten. + +Die Installation der Abhängigkeiten kann je nach Internetverbindung und Systemleistung zwischen 5 und 15 Minuten dauern. + +::: info NICHT UNTERSTÜTZTE DISTRIBUTIONEN +Für andere Distros installiere zuerst die Abhängigkeiten und überspringe das Setup-Skript im Installer. +::: + +Die Dotfiles werden in `~/.mydotfiles` installiert und per Symlink in `~/.config` eingebunden. + +::: info EMPFEHLUNG +Ich empfehle, vorher ein Basis-Hyprland-System zu installieren. So hast du einen stabilen Ausgangspunkt, um Hyprland vorab zu testen. Hyprland ist komplex, in aktiver Entwicklung und benötigt zusätzliche Komponenten. + +Unter Arch Linux kannst du zuerst das Hyprland Desktop Profile installieren. + +Hyprland-Installationsanleitungen: https://wiki.hyprland.org/Getting-Started/Installation/ +::: + +### Für minimale Arch-Installationen + +Installiere folgende Abhängigkeiten auf einem minimalen Arch-System: + +```sh [ Arch] +sudo pacman -S hyprland vim kitty firefox flatpak + +``` +Starte danach das System neu und starte Hyprland mit: + +```sh [ Arch] +Hyprland + +``` +Öffne Firefox, rufe die Dotfiles Installer-Seite auf und folge den Installationsanweisungen. + +::: warning AUR nicht mehr unterstützt +Bitte beachte, dass AUR-Pakete für die ML4W Dotfiles nicht mehr unterstützt werden. Deinstalliere ggf. alte Pakete: + +```sh +yay -R ml4w-dotfiles # Main Release +yay -R ml4w-dotfiles-git # Rolling Release +``` +::: + +## Installation mit GNU stow + +Die manuelle Installation ohne Dotfiles Installer ist möglich, wird aber nicht empfohlen (insbesondere nicht für Einsteiger). + +> [!NOTE] +> Erstelle vorher ein Backup deiner aktuellen Konfiguration. Diese Anleitung ist noch in Entwicklung. + +Die manuelle Installation erfordert `stow`. Beispiel (Arch): + +```sh +sudo pacman -S stow +``` + +Schritte: + +```sh +mkdir -p ~/Projects # Erstelle ein Projects-Verzeichnis +git clone --depth 1 https://github.com/mylinuxforwork/dotfiles # Rolling Release +cd ~/Projects/dotfiles/setup # in das setup-Verzeichnis wechseln +./setup.sh # Setup-Skript ausführen, um Abhängigkeiten zu installieren +``` +Erstelle Symlinks ins Home-Verzeichnis: + +```sh +cd ~/Projects/dotfiles +stow dotfiles +``` + +Starte das System neu. + +## Installation in einer virtuellen Maschine (KVM) + +In virt-manager aktiviere 3D-Beschleunigung (Video Virtio) und setze "Listen type" auf "None" (Display Spice). + +| Keybind | Aktion | +|--------|--------| +| SUPER + CTRL + S | Hyprland Settings öffnen | +| *(Inside Settings → Environments)* | Wähle `kvm.conf` für bessere VM-Unterstützung | + diff --git a/docs/de/getting-started/migrate.md b/docs/de/getting-started/migrate.md new file mode 100644 index 000000000..662279e99 --- /dev/null +++ b/docs/de/getting-started/migrate.md @@ -0,0 +1,62 @@ +# Migration zum neuen Dotfiles Installer + +Die ML4W Dotfiles für Hyprland werden mit dem Dotfiles Installer verwaltet. Du kannst deine bestehende (Legacy-)Installation auf das neue Dotfiles-Installer-Setup migrieren, indem du die folgenden Schritte ausführst. + +::: info +Version 0.9.1 des Dotfiles Installer oder neuer wird benötigt +::: + +### 1. Dotfiles Installer installieren + +Klicke auf das Badge unten, um den Dotfiles Installer von Flathub zu installieren. + + + +### 2. Dotfiles Installer starten + +Öffne den App-Launcher oder starte die App über die Kommandozeile: + +```sh +flatpak run com.ml4w.dotfilesinstaller +``` +### 3. .dotinst-Datei laden und neueste Version herunterladen + +Kopiere die folgende URL in den Dotfiles Installer und klicke auf "Load". + +#### Stabile Version + +```sh +https://raw.githubusercontent.com/mylinuxforwork/dotfiles/main/hyprland-dotfiles-stable.dotinst +``` +#### Rolling-Version + +```sh +https://raw.githubusercontent.com/mylinuxforwork/dotfiles/main/hyprland-dotfiles.dotinst +``` +Klicke anschließend auf "Download", um die neueste Version herunterzuladen. + +Führe das Setup-Skript aus, um die aktuellen Abhängigkeiten zu installieren. + +::: info +Du kannst den Setup-Schritt vermutlich überspringen, wenn du bereits die neueste Version installiert hast. +::: + +### 4. Dotfiles migrieren + +Nachdem du die Dotfiles heruntergeladen hast, öffne im Installer das Ordner-Menü und wähle "Open Prepared Folder". Ersetze alle Dateien im `prepared`-Ordner durch die Dateien und Ordner aus `~/dotfiles`. + +![image](/migrate.jpg) + +Anschließend klicke auf `Migrate from Prepared Folder`. + +### 5. Konfiguration schützen + +Wenn du eigene Anpassungen an den Dotfiles vorgenommen hast, wähle die Dateien und Ordner aus, die während Installation oder Update nicht überschrieben werden sollen. Deine Auswahl wird für zukünftige Updates gespeichert. + +### 6. Dotfiles installieren + +Du kannst die Dotfiles direkt installieren und aktivieren. + +### 7. Dotfiles aktualisieren + +Die Dotfiles können jederzeit über den Startbildschirm des Dotfiles Installer auf die neueste Version aktualisiert werden. diff --git a/docs/de/getting-started/overview.md b/docs/de/getting-started/overview.md new file mode 100644 index 000000000..e107bf87e --- /dev/null +++ b/docs/de/getting-started/overview.md @@ -0,0 +1,72 @@ +# Übersicht + +
+ +**Eine erweiterte Konfiguration von Hyprland für Arch Linux und Fedora-basierte Distributionen. Dieses Paket enthält ein Installationsskript, das die benötigten Komponenten installiert und einrichtet.** + +
+ +![image](/screen-2992.jpg) + +> [!NOTE] +> Dieses Wiki behandelt die neuesten Funktionen der ML4W Dotfiles. Stelle sicher, dass die aktuellste Version der ML4W Dotfiles auf deinem System installiert ist. Folge den Installations- und Update-Anweisungen. + +Die ML4W Dotfiles können mit dem Dotfiles Installer installiert werden. + + + +## Neueste Funktionen + +Die aktuellen Änderungen findest du im [CHANGELOG](https://github.com/mylinuxforwork/dotfiles/blob/main/CHANGELOG.md) + +## Unterstützte Plattformen + +Die Installation sollte auf allen Arch Linux- und Fedora-basierten Distributionen funktionieren. + +Die ML4W Dotfiles wurden mit folgenden Distributionen getestet: + +- Arch Linux +- EndeavourOS +- Manjaro Linux +- Garuda Linux +- Arco Linux +- CachyOS +- Fedora Workstation 42 +- openSuse Tumbleweed + +> **Für Manjaro-Nutzer:** Hyprland und benötigte Pakete befinden sich in aktiver Entwicklung. Es kann daher vorkommen, dass manche Pakete nicht sofort für Manjaro verfügbar sind. In der Regel werden diese Pakete später bereitgestellt. + +> **Für Arco Linux Nutzer:** Bitte installiere zuerst `hyprutils` mit `yay -S extra/hyprutils` + +## Hauptpakete + +- Terminal: `kitty` +- Editor: `nvim` +- Prompt: `oh-my-posh` +- Wallpaper: `hyprpaper` mit `waypaper` (swww optional) +- Icons: `Font Awesome` +- Startmenüs: `Rofi` (Wayland) +- Farbthema: `pywal` +- Browser: `Firefox` (Chromium und Brave optional) +- Dateimanager: `Nautilus` (yazi und dolphin optional) +- Cursor: `Bibata Modern Ice` +- Icons: `Papirus-Icon-Theme` +- Statusleiste: `waybar` +- Screenshots: `grim` & `slurp` & `grimblast` +- Zwischenablage-Manager: `cliphist` +- Logout: `wlogout` +- Idle-Manager: `hypridle` +- Bildschirmsperre: `hyprlock` +- Dock: `nwg-dock-hyprland` +- GTK Theme Manager: `nwg-look` +- QT6 Theme Manager: `qt6ct` + +![image](/screen-2992-light.jpg) + +![image](/overview-2.png) + +![image](/overview-3.png) + +> [!NOTE] +> Jede Linux-Distribution und Konfiguration kann unterschiedlich sein. Daher kann ich nicht garantieren, dass die Installation überall funktioniert. Installation erfolgt auf eigenes Risiko. + diff --git a/docs/de/getting-started/uninstall.md b/docs/de/getting-started/uninstall.md new file mode 100644 index 000000000..d76ad7232 --- /dev/null +++ b/docs/de/getting-started/uninstall.md @@ -0,0 +1,68 @@ +# Deinstallation der ML4W Dotfiles + +Die Deinstallation erfordert einige manuelle Schritte. Dazu gehören das Entfernen der Dotfiles, das Wiederherstellen von Konfigurationsdateien aus dem Backup und das Deinstallieren nicht mehr benötigter Abhängigkeiten. + +> [!WARNING] +> Die Deinstallation ist ein sehr individueller Prozess. Es gibt keine Garantie, dass die folgenden Schritte auf allen Systemen funktionieren. + +> [!NOTE] +> Die folgenden Anweisungen sind noch in Arbeit. Der Dotfiles Installer wird in einem der kommenden Updates eine Deinstallationsfunktion enthalten. Teile bitte deine Erfahrungen auf GitHub. + +## Entferne die Hyprland-Konfiguration + +Melde dich von den ML4W Dotfiles ab und wechsle zu einer anderen Desktop-Umgebung (falls vorhanden) oder auf eine TTY. + +```sh +cd ~/.config # ins Config-Verzeichnis wechseln +rm -rf hypr # Entfernt den aktuellen Symlink zur ML4W hypr-Konfiguration +``` +Wenn du auf einer TTY arbeitest, kannst du dich danach wieder bei Hyprland anmelden und solltest die Standardkonfiguration sehen. Bitte beachte, dass du jetzt kitty mit SUPER+Q öffnen musst. + +## Stelle dein erstes Backup wieder her + +Kopiere die Dateien aus deinem ersten Backup, das du mit dem Dotfiles Installer erstellt hast, zurück in dein Home- und `.config`-Verzeichnis. Halte die Ordnerstruktur deines Backups bei. + +Das Backup-Verzeichnis findest du hier: + +```sh +cd ~/.var/app/com.ml4w.dotfilesinstaller/data/backup +cd com.ml4w.dotfiles # für Rolling Release +cd com.ml4w.dotfiles.stable # für Stable Release +``` +## Symlinks löschen (optional) + +Entferne alle Symlinks in deinem Home- und `.config`-Verzeichnis, die auf den `.mydotfiles`-Ordner zeigen. + +```sh +cd ~/.config +rm -rf waybar # Beispiel +``` + +## Dotfiles-Ordner entfernen (optional) + +Öffne den folgenden Ordner und entferne die Dotfiles: + +```sh +cd ~/.mydotfiles +rm -rf com.ml4w.dotfiles # für Rolling Release +rm -rf com.ml4w.dotfiles.stable # für Stable Release +``` +## Abhängigkeiten deinstallieren (optional) + +Du kannst Abhängigkeiten entfernen, die du nicht mehr benötigst. + +> [!WARNING] +> Bitte stelle sicher, dass du keine Pakete entfernst, die für dein System erforderlich sind. + +## ML4W Apps deinstallieren + +Führe die folgenden Befehle aus, um die ML4W Flatpak-Apps von deinem System zu entfernen: + +```sh +flatpak uninstall com.ml4w.welcome +flatpak uninstall com.ml4w.settings +flatpak uninstall com.ml4w.calendar +flatpak uninstall com.ml4w.sidebar +flatpak uninstall com.ml4w.hyprlandsettings + +``` diff --git a/docs/de/getting-started/update.md b/docs/de/getting-started/update.md new file mode 100644 index 000000000..7a28a0327 --- /dev/null +++ b/docs/de/getting-started/update.md @@ -0,0 +1,16 @@ +# Update + +> [!NOTE] +> Du kannst ein Backup deiner aktuellen Konfiguration mit der Backup-Funktion des Dotfiles Installer erstellen. + +## Update mit dem Dotfiles Installer + +Wenn du die Dotfiles mit dem Dotfiles Installer installiert hast, öffne den Installer und klicke auf das Aktualisieren-Symbol (Refresh), um das Update zu starten. + +![image](/update-dotfiles.jpg) + +Der Dotfiles Installer bietet an, ein Backup zu erstellen, vorhandene Einstellungen wiederherzustellen und eigene Anpassungen (falls nötig) zu schützen. + +::: warning RESTORE AND PROTECT +Jede Version der ML4W Dotfiles bringt neue Funktionen und aktualisierte Konfigurationsdateien mit sich. Um Nebenwirkungen beim Update zu minimieren, reduziere die Anzahl der wiederhergestellten Dateien auf ein Minimum. +::: \ No newline at end of file diff --git a/docs/de/help/troubleshooting.md b/docs/de/help/troubleshooting.md new file mode 100644 index 000000000..9fdfbdee9 --- /dev/null +++ b/docs/de/help/troubleshooting.md @@ -0,0 +1,64 @@ +# Fehlerbehebung + +## Probleme mit dem SDDM Sequoia Theme + +
+ +Wenn du einen Fehler mit dem neuen Sequoia-Theme bemerkst, kannst du das Theme deinstallieren mit: + +```sh +sudo rm -rf /usr/share/sddm/themes/sequoia +``` + +Öffne `/etc/sddm.conf.d/sddm.conf` und setze das Standardtheme zurück: + +```ini +[Theme] +Current=elarum +``` +
+ +## Waybar lädt nicht + +
+ +Dass Waybar nicht lädt, tritt häufig nach einer frischen Installation der ML4W Dotfiles auf. Ursache kann der Startprozess von `xdg-desktop-portal-gtk` sein. Es kann auch passieren, wenn du Hyprland ein zweites Mal aus einer TTY heraus startest. + +Wenn Waybar nicht lädt, starte zuerst das System neu und prüfe, ob das Problem weiterhin besteht. + +Öffne ein Terminal mit `SUPER+Return` und gib `wlogout` ein. + +Wenn es weiterhin nicht funktioniert, versuche `xdg-desktop-portal-gtk` zu entfernen: + +```sh +sudo pacman -R xdg-desktop-portal-gtk +``` + +Starte das System erneut. + +Waybar sollte nun funktionieren, allerdings verlierst du damit die Dunkelmodus-Unterstützung in Libadwaita-Apps (z. B. `nautilus`). Die ML4W Apps funktionieren weiterhin im Dunkelmodus. + +Installiere es anschließend wieder mit: + +```sh +sudo pacman -S xdg-desktop-portal-gtk +``` + +Bitte stelle außerdem sicher, dass `xdg-desktop-portal-gnome` nicht parallel zu `xdg-desktop-portal-gtk` installiert ist. Entferne gegebenenfalls das Paket. + +Wenn das Problem weiterhin besteht, entferne `xdg-desktop-portal-gtk`. Falls du Dunkelmodus benötigst, installiere `dolphin`, `qt6ct` und aktiviere Breeze bzw. dunklere Farbschemata, um einen Dateimanager mit Dunkelmodus zu erhalten. + +
+ +## Fehlende Icons in Waybar + +
+ +Bei fehlenden Icons in Waybar handelt es sich oft um einen Konflikt zwischen mehreren installierten Schriftarten (besonders auf **Arco Linux**). Stelle sicher, dass `ttf-ms-fonts` deinstalliert ist und `ttf-font-awesome` sowie `otf-font-awesome` installiert sind: + +```sh +yay -R ttf-ms-fonts +yay -S ttf-font-awesome otf-font-awesome +``` + +
diff --git a/docs/de/index.md b/docs/de/index.md new file mode 100644 index 000000000..21047a5a9 --- /dev/null +++ b/docs/de/index.md @@ -0,0 +1,124 @@ +--- +layout: home +pageClass: home-page + +hero: + name: Die ML4W Dotfiles für Hyprland + image: + src: /ml4w.svg + alt: ML4W logo + style: "width: 200px; height: auto;" + tagline: Eine leistungsfähige und umfassende Konfiguration für den dynamischen Tiling-Fenstermanager Hyprland. + actions: + - theme: brand + text: Erste Schritte + link: /getting-started/overview + - theme: alt + text: Installieren + link: /getting-started/install + - theme: alt + text: GitHub ↗ + link: https://github.com/mylinuxforwork/dotfiles + +features: + - icon: scripts + title: Einfache Installation + details: Unterstützung durch den Dotfiles Installer und Installationsskripte, um alle Abhängigkeiten für Arch, Fedora und openSuse zu installieren. + + - icon: theme + title: Dynamische Designs & Desktop + details: Erlebe einen vollständigen Desktop mit Hyprland, adaptiven Material-Design-Themes und umfangreichen Anpassungsmöglichkeiten via Dotfiles. + + - icon: configuration + title: Viele Anpassungsoptionen + details: Inklusive nützlicher grafischer Apps zur Konfiguration, zum Wechseln von Themes und zum Feintuning deiner Umgebung. + +metaTitle: "Die ML4W-Dotfiles für Hyprland" +description: Eine leistungsfähige und vollständige Konfiguration für den dynamischen Tiling-Fenstermanager Hyprland, inklusive einfacher Installation über den Dotfiles Installer und voller Unterstützung für Arch Linux, Fedora und openSuse. +--- + +preview + +
+ +### Installation + +Du kannst die ML4W-Dotfiles für Hyprland über den Dotfiles Installer aus Flathub installieren.
Klicke auf das untenstehende Badge, um die App zu installieren. + + + +Kopiere die folgende URL in den Dotfiles Installer und starte die Installation. + +#### Stabile Version + +```sh +https://raw.githubusercontent.com/mylinuxforwork/dotfiles/main/hyprland-dotfiles-stable.dotinst +``` +#### Rolling-Version + +```sh +https://raw.githubusercontent.com/mylinuxforwork/dotfiles/main/hyprland-dotfiles.dotinst +``` +Installationsskripte zur Einrichtung der benötigten Abhängigkeiten sind für **Arch, Fedora und openSuse Tumbleweed** enthalten.
+Für andere Distributionen installiere bitte zuerst die Abhängigkeiten. + +
+ + diff --git a/docs/de/ml4w-apps/dotfiles-app.md b/docs/de/ml4w-apps/dotfiles-app.md new file mode 100644 index 000000000..7f4be6075 --- /dev/null +++ b/docs/de/ml4w-apps/dotfiles-app.md @@ -0,0 +1,20 @@ +# Dotfiles Einstellungen + +Du kannst die ML4W Dotfiles Einstellungen mit `SUPER + CTRL + S` öffnen, um ausgewählte Dotfiles-Konfigurationen zu ändern und Variationen für deine `hyprland.conf` zu wählen, damit du dein Desktop-Setup weiter anpassen kannst. + +![Screenshot](/settings.jpg) + +Du kannst eigene Variationen erstellen, indem du eine Datei aus den Unterordnern `~/dotfiles/hypr/conf` (z. B. `monitor/default.conf`) kopierst, der Datei einen eigenen Namen gibst (z. B. `mymonitor.conf`) und die Variation in der Dotfiles-Einstellungs-App im entsprechenden Bereich auswählst. + +> [!IMPORTANT] +> Die ML4W Dotfiles Settings App ersetzt Strings in mehreren Konfigurationsdateien direkt oder anhand von Ersetzungs-Kommentaren (z. B. // START WORKSPACES). Entferne diese Kommentare oder Marker nicht, damit die App vollständig funktioniert. + +Du kannst auch die Datei `custom.conf` bearbeiten, welche am Ende der `hyprland.conf` eingebunden wird und deine persönlichen Einstellungen aufnehmen kann. + +Den Quellcode findest du im Repository der ML4W Dotfiles Settings App: https://github.com/mylinuxforwork/dotfiles-settings + +Du kannst die Dotfiles App auch aus dem Terminal starten mit: + +```sh +ml4w-settings +``` diff --git a/docs/de/ml4w-apps/hyprland-app.md b/docs/de/ml4w-apps/hyprland-app.md new file mode 100644 index 000000000..f865d8c83 --- /dev/null +++ b/docs/de/ml4w-apps/hyprland-app.md @@ -0,0 +1,26 @@ +# Hyprland Einstellungen + +Diese Anwendung hilft dir, deine Hyprland-Installation anzupassen. Du kannst bestehende Konfigurationen mit eigenen Werten überschreiben, ohne komplexe Konfigurationsdateien hinzufügen zu müssen. + +![Screenshot](/hyprland-settings.jpg) + +
+ +Du kannst die Anwendung über den Anwendungsstarter, die ML4W Sidebar (durch Klicken auf das ML4W-Logo) oder die Welcome-App starten. + +Die App zeigt Variablen und aktuelle Werte deiner laufenden Hyprland-Instanz an. + +Du kannst die Werte ändern und die bestehenden Einstellungen überschreiben. Die Änderung wird sofort übernommen. + +Im Reiter "Set Variables" siehst du, welche Werte du überschrieben hast und kannst alte Werte wiederherstellen, indem du den Eintrag entfernst. + +Du kannst die Hyprland App auch aus dem Terminal starten mit: + +```sh +ml4w-hyprland +``` + +
+ +Den Quellcode findest du im Repository der ML4W Hyprland Settings App: https://github.com/mylinuxforwork/hyprland-settings + diff --git a/docs/de/ml4w-apps/sidebar.md b/docs/de/ml4w-apps/sidebar.md new file mode 100644 index 000000000..1d74d28ec --- /dev/null +++ b/docs/de/ml4w-apps/sidebar.md @@ -0,0 +1,26 @@ +# Sidebar + +Mit der ML4W Sidebar hast du Zugriff auf alle enthaltenen ML4W-Anwendungen und einige Systeminformationen. + +Du kannst die Sidebar auch aus dem Terminal starten mit: +```sh +ml4w-sidebar +``` + + +
+ +![image](/sidebar.jpg) + +
+ +Über die Sidebar erreichst du folgende Funktionen: + +- Update Wallpaper: Öffnet den Wallpaper-Selector +- Change Waybar Theme: Öffnet den Waybar-Theme-Switcher und zeigt die verfügbaren Themes für die Waybar-Statusleiste an +- Change GTK Theme: Öffnet nwg-look, um das Theme für GTK3-Anwendungen (inkl. Widgets, Icons und Cursor) auszuwählen +- Refresh GTK Settings: Lädt die Hyprland GTK-Konfiguration neu (erforderlich beim Wechsel des Maus-Cursors) +- Hyprland Settings: Öffnet das Hyprland Settings Script, um Look & Feel, Umgebungsvariablen, Monitorauflösung usw. anzupassen +- Reload Waybar: Lädt Waybar neu +- Toggle Waybar: Blendet Waybar ein/aus, z. B. um andere Statusleisten auszuprobieren +- Toggle Dock: Blendet das Dock ein/aus diff --git a/docs/de/ml4w-apps/welcome.md b/docs/de/ml4w-apps/welcome.md new file mode 100644 index 000000000..8e70eaa50 --- /dev/null +++ b/docs/de/ml4w-apps/welcome.md @@ -0,0 +1,17 @@ +# Welcome App + +Nach dem ersten Start der ML4W Dotfiles öffnet sich die ML4W Welcome App. Diese App ist der Einstiegspunkt, um das Hyprland-Setup zu entdecken. + +![image](/welcome.jpg) + +Du kannst die Welcome App auch aus dem Terminal starten mit: + +```sh +ml4w +``` +Die Willkommensansicht enthält die wichtigsten Tastenkombinationen, um ein Terminal oder einen Browser zu öffnen. + +Du kannst die ML4W Welcome App auch aus der Sidebar starten, indem du in Waybar auf das `L`-Icon rechts klickst, den Rofi-Anwendungsstarter verwendest oder `ml4w` im Terminal eingibst (wenn du die `.bashrc` aus den Dotfiles benutzt). + +Den Quellcode findest du im Repository der ML4W Welcome App: https://github.com/mylinuxforwork/dotfiles-welcome + diff --git a/docs/de/qtile/qtile.md b/docs/de/qtile/qtile.md new file mode 100644 index 000000000..81036bff4 --- /dev/null +++ b/docs/de/qtile/qtile.md @@ -0,0 +1,9 @@ +
+ +

Qtile wurde von den ML4W Dotfiles für Hyprland getrennt.

+ +--- + +**Die Konfiguration findest du hier:** https://github.com/mylinuxforwork/qtile + +
diff --git a/docs/de/showcases/Showcase.vue b/docs/de/showcases/Showcase.vue new file mode 100644 index 000000000..0af00c221 --- /dev/null +++ b/docs/de/showcases/Showcase.vue @@ -0,0 +1,130 @@ + + + + + diff --git a/docs/de/showcases/Showcases.vue b/docs/de/showcases/Showcases.vue new file mode 100644 index 000000000..223714246 --- /dev/null +++ b/docs/de/showcases/Showcases.vue @@ -0,0 +1,70 @@ + + + + + diff --git a/docs/de/showcases/index.md b/docs/de/showcases/index.md new file mode 100644 index 000000000..32a9a334f --- /dev/null +++ b/docs/de/showcases/index.md @@ -0,0 +1,12 @@ +--- +layout: home +footer: false +--- + + + + + + diff --git a/docs/de/showcases/showcases.ts b/docs/de/showcases/showcases.ts new file mode 100644 index 000000000..bf2636f2d --- /dev/null +++ b/docs/de/showcases/showcases.ts @@ -0,0 +1,37 @@ +type Showcase = { + image: string + title: string +} + +const showcases: Showcase[] = [ + { + videoUrl: "https://www.youtube.com/embed/40NhOyP3a18", + title: "" + }, + { + videoUrl: "https://www.youtube.com/embed/k6KKhgVqVIM", + title: "" + }, + { + image: "/dotfiles/ss/ss.png", + title: "", + }, + { + image: "/dotfiles/ss/ss1.png", + title: "", + }, + { + image: "/dotfiles/ss/ss2.png", + title: "", + }, + { + image: "/dotfiles/dock.png", + title: "", + } +// { +// videoUrl: "/dotfiles/test.mp4", +// title: "" +// }, +] + +export default showcases diff --git a/docs/de/usage/game-mode.md b/docs/de/usage/game-mode.md new file mode 100644 index 000000000..ea13f0ff1 --- /dev/null +++ b/docs/de/usage/game-mode.md @@ -0,0 +1,19 @@ +# Spielmodus + +Du kannst einen Spielmodus aktivieren, um die Leistung in Spielsituationen zu erhöhen, entweder über die Sidebar-App oder per Tastenkürzel: + +| Tastenkürzel | Aktion | +|--------|--------| +| SUPER + ALT + G | Hyprland-Animationen und Fenster-Unschärfe deaktivieren | + +Mit demselben Tastenkürzel kannst du die Effekte auch wieder einschalten. + +Wenn du den Spielmodus dauerhaft aktivieren möchtest, kannst du die zugehörigen Variationen in der ML4W Settings App aktivieren: + +Öffne den Tab „Appearance“ und setze die Variationen auf: + +- Decoration Variations: `gamemode.conf` +- Window Variations: `gamemode.conf` +- Animation Variations: `disabled.conf` + +![image](/gamemode-settings.jpg) diff --git a/docs/de/usage/keybindings.md b/docs/de/usage/keybindings.md new file mode 100644 index 000000000..3de3c78cf --- /dev/null +++ b/docs/de/usage/keybindings.md @@ -0,0 +1,35 @@ +# Tastenkürzel + +Hier sind die wichtigsten Tastenkürzel, die du kennen solltest, um mit den ML4W Dotfiles und Hyprland zu starten: + +### 🖥️ Fenster- & Arbeitsflächenverwaltung + +| Tastenkürzel | Aktion | +|--------|--------| +| SUPER + 1–5 | Wechsel zu Arbeitsfläche 1–5 | +| SUPER + T | Zwischen Floating- und Tiling-Fenster umschalten | +| SUPER + 🖱️ Linksklick | Fenster verschieben | +| SUPER + 🖱️ Rechtsklick | Fenstergröße ändern | +| SUPER + Q | Aktives Fenster schließen | + +### 💻 Anwendungen & Werkzeuge + +| Tastenkürzel | Aktion | +|--------|--------| +| SUPER + RETURN | Terminal öffnen | +| SUPER + B | Browser öffnen | +| SUPER + CTRL + RETURN | `rofi`-Anwendungsstarter starten | +| SUPER + CTRL + S | ML4W Settings Skript starten | + +### 🧭 UI & Umgebung + +| Tastenkürzel | Aktion | +|--------|--------| +| SUPER + SHIFT + W | Wallpaper ändern | +| SUPER + SHIFT + B | Waybar neu laden | +| SUPER + PRINT | Screenshot erstellen | +| SUPER + CTRL + Q | Logout-Bildschirm öffnen | + +Alle Hyprland-Tastenkürzel findest du auch per Rechtsklick auf Apps in Waybar oder hier: + +- [Hyprland keybindings overview](https://github.com/mylinuxforwork/dotfiles/blob/main/dotfiles/.config/hypr/conf/keybindings/default.conf) diff --git a/docs/de/usage/launch.md b/docs/de/usage/launch.md new file mode 100644 index 000000000..17ce8ae4b --- /dev/null +++ b/docs/de/usage/launch.md @@ -0,0 +1,16 @@ +# Hyprland starten + +## Über SDDM + +Die empfohlene Methode, die ML4W Dotfiles für Hyprland zu starten, ist über den Display Manager SDDM. + +--- + +## Von der TTY + +Du kannst Hyprland auch von der Kommandozeile aus starten: + +```sh +# Hyprland starten +Hyprland +``` diff --git a/docs/de/usage/screenshots.md b/docs/de/usage/screenshots.md new file mode 100644 index 000000000..2dce57243 --- /dev/null +++ b/docs/de/usage/screenshots.md @@ -0,0 +1,34 @@ +# Screenshots + +Die ML4W Dotfiles werden mit `grimblast` ausgeliefert. Du kannst das Screenshot-Menü mit `SUPER + PRINT` öffnen. + +Bitte folge dem Screenshot-Assistenten. + +![image](/screenshot.png) + +## Screenshot-Verzeichnis ändern + +Standardmäßig werden Screenshots im Verzeichnis `$HOME/Pictures` abgelegt. + +Um den Screenshot-Ordner zu ändern, öffne `~/.config/ml4w/settings/screenshot-folder.sh`. + +## Dateinamensformat der Screenshots ändern + +Standardmäßig werden Screenshots im Verzeichnis `$HOME/Pictures` gespeichert. + +Um das Dateinamensformat zu ändern, öffne `~/.config/ml4w/settings/screenshot-filename.sh`. + +## Screenshot Editor + +Wenn du als letzte Option „edit“ wählst, wird das erstellte Screenshot in Pinta geöffnet. Pinta ermöglicht grundlegende Bildbearbeitungsaufgaben. + +![image](/screenshot1.png) + +Du kannst den Screenshot-Editor in der ML4W Settings App ändern: + +![image](/screenshot2.png) + +Beispiele: +- Für `swappy` gib `swappy -f` ein +- Für `gimp` gib `gimp` ein + diff --git a/docs/de/usage/sidepad.md b/docs/de/usage/sidepad.md new file mode 100644 index 000000000..7b37ae001 --- /dev/null +++ b/docs/de/usage/sidepad.md @@ -0,0 +1,80 @@ +# Sidepad + +Der Sidepad ist ein praktisches Feature, um dauerhaft ein Fenster auf allen Arbeitsflächen verfügbar zu haben. + +![image](/sidepad-open.jpg) + +Beim Aufrufen des Sidepad erscheint der rechte Fensterrahmen am linken Bildschirmrand. Mit Tastenkürzeln kannst du das Fenster ein- oder vollständig vergrößern. + +![image](/sidepad-closed.jpg) + +Der Sidepad eignet sich als Ersatz für ein Scratchpad, für Terminals oder KI-Hilfen, die dauerhaft erreichbar sein müssen. + +## Tastenkürzel + +Die ML4W Dotfiles enthalten folgende Sidepad-Tastenkürzel: + +- SUPER + S: Sidepad initialisieren +- SUPER + Shift + S: Öffnet den Sidepad-Selector +- SUPER + CTRL + rechts: Öffnet den Sidepad in kompakter Breite +- SUPER + CTRL + rechts: Öffnet den Sidepad in voller Breite +- SUPER + CTRL + links: Schließt den Sidepad + +Du findest zusätzlich eine spezielle Sektion in der ML4W Sidebar. + +## Konfiguration + +Der Sidepad in den ML4W Dotfiles wird mit folgenden Konfigurationen ausgeliefert: + +### Terminal + +```sh +# Sidepad-Konfiguration für Kitty +SIDEPAD_APP="kitty" +SIDEPAD_CLASS="dotfiles-sidepad" +``` + +### KI-Unterstützung + +```sh +# Sidepad-Konfiguration für Newelle +# Installation: flatpak install io.github.qwersyk.Newelle +SIDEPAD_APP="flatpak run io.github.qwersyk.Newelle" +SIDEPAD_CLASS="io.github.qwersyk.Newelle" +SIDEPAD_OPTIONS="--width 700" +``` +### Browser + +```sh +# Sidepad-Konfiguration für Firefox +SIDEPAD_APP="firefox --no-remote -P default --name dotfiles-sidepad" +SIDEPAD_CLASS="dotfiles-sidepad" +``` + +Du kannst eigene Sidepad-Konfigurationen in `~/.config/sidepad/pads` ablegen. Die Konfiguration erscheint automatisch im Sidepad-Selector. + +## Scripting + +Das Sidepad-Skript funktioniert auch eigenständig ohne die ML4W Dotfiles. + +Das Skript findest du hier: https://github.com/mylinuxforwork/dotfiles/tree/main/dotfiles/.config/sidepad + +```sh +Options: + --class Override the window class (Default: dotfiles-sidepad) + --hidden-gap Override the hidden left gap (Default: 10) + --visible-gap Override the visible left gap (Default: 20) + --width Override the target width (Default: 500) + --width-max Override the maximum target width (Default: 1000) + --top-gap Override the top gap (Default: 76) + --bottom-gap Override the bottom gap (Default: 91) + --hide Force the window to the hidden state. + --kill Kills the running app with WINDOW_CLASS. + -h, --help Display this help and exit +``` + +Du kannst die Sidepad-Funktionen skripten, indem du ein eigenes Dispatcher-Skript erstellst und es mit deinen Tastenkürzeln verbindest. + +Der Sidepad-Dispatcher für die ML4W Dotfiles ist hier verfügbar: https://github.com/mylinuxforwork/dotfiles/blob/main/dotfiles/.config/ml4w/scripts/sidepad.sh + + diff --git a/docs/de/usage/wallpapers.md b/docs/de/usage/wallpapers.md new file mode 100644 index 000000000..1ffb77670 --- /dev/null +++ b/docs/de/usage/wallpapers.md @@ -0,0 +1,67 @@ +# Wallpaper mit Waypaper (hyprpaper; swww optional) + +Du kannst ein Wallpaper mit Waypaper auswählen. Waypaper lässt sich über den App-Launcher oder die Sidebar starten. + +> [!NOTE] +> Zusätzliche Wallpaper findest du im ML4W Wallpaper Repository: https://github.com/mylinuxforwork/wallpaper + +### 🎨 Wallpaper-Tastenkürzel + +| Tastenkürzel | Aktion | +|--------|--------| +| SUPER + SHIFT + W | Wallpaper ändern (zufällig aus `~/wallpaper/`) | +| SUPER + CTRL + W | Waypaper öffnen | +| SUPER + ALT + W | Wallpaper-Automatik starten/stoppen | + +![image](/wallpapers.png) + +> In Waypaper kannst du ein Wallpaper aus jedem Ordner deines Systems auswählen. + +> Die Standard-Wallpaper-Engine ist **`hyprpaper`**. Optional kannst du **swww** installieren und in der ML4W Settings App von `hyprpaper` auf `swww` wechseln. + +> Öffne die ML4W Settings App und wähle den Tab „System“. Oben findest du den Wallpaper-Engine-Selector. + +> [!NOTE] +> Ein Logout und Login ist erforderlich, um die neue Wallpaper-Anwendung zu aktivieren. + +Die `hyprpaper`-Engine verwendet eine Template-Datei unter `dotfiles/.settings/hyprpaper.tpl`. Dort kannst du zusätzliche Konfigurationen ergänzen. Platzhalter wie `WALLPAPER` werden mit dem ausgewählten Wallpaper ersetzt. + +## Wallpaper-Automatik + +Du kannst die automatische Wallpaper-Änderung mit dem oben genannten Tastenkürzel aktivieren. Der Prozess lässt sich mit demselben Tastenkürzel stoppen. + +Die Wartezeit (in Sekunden) zwischen den Wechseln (Standard: 60 Sekunden) kannst du in `~/.config/ml4w/settings/wallpaper-automation.sh` einstellen. + +## Wallpaper-Effekte + +Du kannst Wallpaper-Effekte aktivieren, um die Darstellung des ausgewählten Hintergrundbilds zu verändern. Ein Rechtsklick auf das Wallpaper-Symbol in Waybar öffnet ein Menü zur Auswahl des Effekts. + +![Screenshot](/wall-effect.png) + +Eigene Effekte legst du in `/dotfiles/hypr/effects/wallpaper` ab. + +Du kannst mehrere `magick`-Befehle ausführen. `$wallpaper` ist das ausgewählte Wallpaper, `$used_wallpaper` die erzeugte Version. + +```sh +magick $wallpaper -negate $used_wallpaper +magick $used_wallpaper -brightness-contrast -20% $used_wallpaper +``` + +## Wallpaper-Cache + +Generierte Versionen eines Wallpapers werden im Ordner `~/.config/ml4w/cache/wallpaper-generated` zwischengespeichert. Dadurch beschleunigt sich der Wechsel zwischen Wallpapers, falls gecachte Dateien vorhanden sind. + +Du kannst den Cache in der ML4W Settings App deaktivieren. + +Den Cache kannst du in der ML4W Settings App leeren oder mit: + +```sh +~/.config/hypr/scripts/wallpaper-cache.sh +``` + +Du kannst die Version des aktuellen Wallpapers neu erzeugen, indem du den Cache in den Einstellungen ausschaltest und dasselbe Wallpaper erneut auswählst. + +## ML4W Wallpaper Repository + +Weitere Wallpaper findest du im [ML4W Wallpaper repository](https://github.com/mylinuxforwork/wallpaper/blob/main/README.md) + diff --git a/docs/development/wiki.md b/docs/development/wiki.md index e96e5bcef..e0eadeac9 100644 --- a/docs/development/wiki.md +++ b/docs/development/wiki.md @@ -51,13 +51,32 @@ Also, I request you not to rewrite or fully write things using LLMs. Please we don't want to see `em dashes` here. > We want the docs to be clean & minimal so please follow these guidelines. - ## Multi-Lang Support -This is not planned yet. But in case someone in the future knows how to implement multi-lang support with Vitepress, you're more than welcome to contribute. - -The first language we are expecting support for is German (`de`). +> [!WARNING] +> +> Documentation in languages other than English may not be up to date. Check the date and the ml4w version shown, and consult the English documentation if in doubt. + +** To add a new language, follow these steps:** + +1. Create a folder named with the language code (e.g., `docs/de/`) and put the translated Markdown files there. +2. Add the locale in `.vitepress/config.ts`. Minimal example: + +```ts +// .vitepress/config.ts +export default { + locales: { + de: { + label: "Deutsch", + lang: "de-DE", + title: 'ML4W Dotfiles für Hyprland Wiki', + description: 'Eine fortschrittliche und voll ausgestattete Konfiguration für den dynamischen Tiling-Window-Manager Hyprland', + } + } +} +``` -If you're interested in implementing multi-lang support, you can refer to [this docs](https://github.com/carch-org/docs), where multi-lang setup has already been done, for reference. +3. Verify routes and navigation use the language prefix (e.g., `/de/`) and update internal links accordingly. +4. In this section, indicate the date and the ml4w version corresponding to the last modification of the documentation in that language. > Thank you for your support. diff --git a/docs/help/troubleshooting.md b/docs/help/troubleshooting.md index a67a0c9a6..e1f3d980e 100644 --- a/docs/help/troubleshooting.md +++ b/docs/help/troubleshooting.md @@ -12,7 +12,7 @@ sudo rm -rf /usr/share/sddm/themes/sequoia Open from /etc/sddm.conf.d/sddm.conf and restore back the default theme. -```sh +```ini [Theme] Current=elarum ``` diff --git a/docs/usage/keybindings.md b/docs/usage/keybindings.md index 6d9f4b356..73ad57891 100644 --- a/docs/usage/keybindings.md +++ b/docs/usage/keybindings.md @@ -32,4 +32,4 @@ Here are the most important keybindings that you need to know to start with the All keybindings for Hyprland with right mouse click on Apps in waybar or here: -- [Hyprland keybindings overview](https://github.com/mylinuxforwork/dotfiles/blob/main/share/dotfiles/.config/hypr/conf/keybindings/default.conf) +- [Hyprland keybindings overview](https://github.com/mylinuxforwork/dotfiles/blob/main/dotfiles/.config/hypr/conf/keybindings/default.conf) diff --git a/docs/usage/screenshots.md b/docs/usage/screenshots.md index 7f5c091d7..45a989e2a 100644 --- a/docs/usage/screenshots.md +++ b/docs/usage/screenshots.md @@ -28,5 +28,5 @@ You can change the screenshot editor in the ML4W Settings App: ![image](/screenshot2.png) -For example if you want to use swappy enter `spappy -f`. If you want to use gimp enter `gimp` +For example if you want to use swappy enter `swappy -f`. If you want to use gimp enter `gimp`