wtf is the_quickshell_book?

The Quickshell Book is a documentation project that teaches people how to build custom desktop environments for Linux using two tools called Quickshell and QML. Quickshell is a framework for building the visual pieces of a desktop, like panels, taskbars, and widgets, on systems using the Wayland display protocol, and QML is the language used to describe how those pieces look and behave. Rather than being a single piece of software you install and run, this project is a guided course. It is organized as a website you can read in your browser, built with the VitePress documentation tool, alongside a large folder of runnable example projects that match each chapter. The examples start from a very first hello world QML application and gradually build up in complexity, covering QML basics, working with data models, and building a calculator app, before moving into Quickshell specific material like different window types, transparency and blur effects, and a full top panel project. Later chapters cover building an app launcher, a network menu, and other individual shell components, and the book finishes by walking through a complete desktop shell that ties everything together. To read the book locally, you clone the repository, install its dependencies with npm, and start a local development server that serves the book in your browser. Running the actual QML examples requires Quickshell itself installed on your machine, and the standalone QML lessons that do not depend on Quickshell need Qt6 instead, so you can follow those without setting up the full shell environment first. The project keeps a clear separation between the book's written content, which lives in a docs folder as Markdown files, and the runnable code, which lives in a separate examples folder organized by chapter number. This structure makes it straightforward to jump directly to any example's source without digging through the surrounding book text. The whole project is released under the MIT license, so anyone can freely reuse the book's content or its example code.