diff --git a/astro.config.mjs b/astro.config.mjs index 7f153de..18b9bcf 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -160,6 +160,7 @@ export default defineConfig({ items: [ { label: "Installation", link: "v5/getting-started/installation/"}, { label: "NixOS", link: "v5/getting-started/nixos/"}, + { label: "Running Noctalia", link: "v5/getting-started/running-the-shell/"}, { label: "Compositor Settings", items: [ diff --git a/src/content/docs/v5/getting-started/running-the-shell.mdx b/src/content/docs/v5/getting-started/running-the-shell.mdx new file mode 100644 index 0000000..92e75df --- /dev/null +++ b/src/content/docs/v5/getting-started/running-the-shell.mdx @@ -0,0 +1,30 @@ +--- +title: Running Noctalia +description: This page gives you a basic example on how to run the shell. +sidebar: + order: 30 +--- + +:::tip[Method] +Use compositor autostart as the primary method. +::: +### Autostart by your Wayland compositor +This is the recommended method for launching noctalia, as it integrates with your window manager. + +For the *Niri* compositor, add the following line to the end of your configuration file, typically located at `~/.config/niri/config.kdl` +```ini +spawn-at-startup "noctalia" +``` + +For the *Hyprland* compositor, append this line to your configuration file, typically located at `~/.config/hypr/hyprland.conf` +```ini +exec-once = noctalia +``` + +--- + +### Manual Launch for Debugging +The most direct way to run Noctalia for testing or debugging. Open a terminal and execute: +```bash +noctalia +```