#22 today ▲ 64

programmersd21/the_quickshell_book

TypeScript Framework #desktop-environment #desktop-shell #desktop-widgets #documentation

📚 A comprehensive, project-based guide to building desktop environments, panels, widgets, and complete shell experiences using Quickshell and QML on Wayland

Created Jul 21, 2026

Stars: 27
Today: +3
Forks: 2
Quality: 100/100
Momentum: 40

README

Fetched from GitHub on Oct 30, 2026, 11:02 PM UTC · README.md

View original on GitHub

Third-party content — Open Source Pulse is not the owner of this repository.

This README belongs to programmersd21/the_quickshell_book and its contributors. We fetch it directly from the project’s public GitHub repository and display it for reference only. All text, code, images and trademarks remain the property of their respective authors. See the repository for its license terms. Copyright / takedown policy.

The Quickshell Book

A comprehensive guide to building Wayland desktop shells with Quickshell and QML.

Quick Start

git clone https://github.com/programmersd21/the_quickshell_book.git
cd the_quickshell_book
npm install
npm run dev

Open http://localhost:5173 in your browser.

Examples

Each chapter comes with runnable QML examples in the examples/ directory:

Directory	Topic	Run With
`001-hello-world/`	First QML app	`qml6 hello.qml`
`002-objects/` through `008-models-delegates/`	QML fundamentals	`qml6 *.qml`
`009-calculator/`	Project: Calculator	`qml6 calculator.qml`
`010-first-shell/` through `012-config-structure/`	Quickshell basics	`quickshell ./`
`020-panel-window/` through `026-transparency-blur/`	Window types	`quickshell ./`
`030-top-panel/`	Project: Top Panel	`quickshell ./`
`040-widgets/`	Reusable widget components	Import into shell
`090-app-launcher/` through `098-network-menu/`	App projects	`quickshell ./`
`111-top-bar/` through `113-launcher/`	Shell components	`quickshell ./`
`900-complete-shell/`	Complete desktop shell	`quickshell ./`

Prerequisites

Quickshell (for most examples)
Qt6 (for qml6 standalone examples)
Node.js >= 24.0.0 and npm (for the book site only)

Development

npm install
npm run dev     # dev server at http://localhost:5173
npm run build   # static output to docs/.vitepress/dist

Project Structure

docs/              # Book content (Markdown)
  .vitepress/      # VitePress configuration and custom theme
  public/          # Static assets (images, favicon)
examples/          # Runnable QML examples by chapter
scripts/           # Utility scripts
public/            # Source assets (favicon, banner)

License

MIT

Rendered by GitHub from the repository’s README. Scroll to read the full file.

First trending

Jul 21, 2026

first spotted on the list

Best rank

#20

highest position reached

Appearances

times on the trending list

Quality score

100

out of 100

Momentum

trend strength indicator

Star velocity

0.27

stars per day since creation

Activity — last 60 days

daily counts, collected every 6 hours

Stars
Forks
Merged PRs
Issues
Closed issues

Collecting activity data since launch — check back in a few days.

Star history

total stars per snapshot

Rank history

position on trending · lower is better

3D card for your website

Live HTML card with a glass surface and pointer tilt. Paste the iframe on any website.

<iframe src="https://www.notionpulse.cc/embed/programmersd21/the_quickshell_book" width="420" height="240" style="border:0;max-width:100%;background:transparent" loading="lazy" title="programmersd21/the_quickshell_book — trending on Open Source Pulse"></iframe>

Stars badge

Show current stars in your README or profile. Auto-updates every 6 hours.

Markdown

[![programmersd21/the_quickshell_book](https://www.notionpulse.cc/api/badge/programmersd21/the_quickshell_book.svg)](https://www.notionpulse.cc/repo/programmersd21/the_quickshell_book)

HTML

<a href="https://www.notionpulse.cc/repo/programmersd21/the_quickshell_book"><img src="https://www.notionpulse.cc/api/badge/programmersd21/the_quickshell_book.svg" alt="programmersd21/the_quickshell_book stars badge" /></a>