Overview

Welcome to the Noctalia documentation! Here you’ll find everything you need to install, configure, and customize your Noctalia shell.

Getting Started

New to Noctalia? Follow these steps:

Start with Installation to get Noctalia on your system
Learn how to run the shell
Explore Configuration to customize your setup

Already installed? Jump straight to Configuration to personalize your shell.

Want to contribute? Check out our Development guidelines.

Common Questions? Check the FAQ First!

Most common issues and questions are already answered in our comprehensive FAQ. Before asking for help, please check if your question is covered there. You’ll find solutions for:

Missing app icons
Compositor-specific configuration
Theming issues
Installation problems
And much more

Documentation Structure

Our documentation is organized into three main sections:

Getting Started - Installation, setup guides, keybinds, and troubleshooting
Configuration - Customize appearance, bar widgets, panels, and behavior
Development - Contributing guidelines, creating widgets, themes, and IPC endpoints

Use the sidebar to browse all available pages organized by topic.

About Noctalia

Noctalia is a beautiful, minimal desktop shell for Wayland built with Quickshell. It’s designed with a “quiet by design” philosophy, providing a complete desktop experience that stays out of your way.

Key Features:

Wayland-native - Built specifically for modern Wayland compositors
Advanced theming - Dynamic color generation with Matugen integration and many predefined color schemes
Multi-compositor support - Works with Niri, Hyprland, Sway and MangoWC
Highly customizable - Extensive widget system and configuration options
Complete desktop experience - Includes panels, dock, notifications, lock screen, and more

Getting Help

FAQ - Check here first for common questions
Discord - Join our community for support and discussion
GitHub - View the source code or report issues
Issue Tracker - Report bugs or request features

Head over to our GitHub organization to see the code or contribute to the project.