bspwm-wiki is a community-maintained, beginner-friendly documentation project for bspwm. It focuses on explaining concepts, configuration, and practical workflows in a clear and approachable way — beyond minimal manpages.
bspwm is powerful, but its official documentation is intentionally minimal. bspwm-wiki aims to bridge the gap between sparse references and real-world usage.
- Clear explanations of bspwm concepts
- Beginner-friendly structure
- Practical configuration examples and snippets
- Community knowledge collected in one place
- New bspwm users getting started for the first time
- Users migrating from i3, dwm, or other tiling window managers
- People who want to understand bspwm, not just copy configs
- Anyone who prefers structured explanations and examples
If you’re new, this path works well:
- Introduction
- bspwm concepts & tree structure
- Basic configuration
- Common recipes and snippets
- Popular configurations for references
The following official and community resources complement bspwm-wiki:
bspwm-wiki is referenced by community bspwm configuration and documentation projects. Other popular bspwm configurations are also referenced in this documentation for gathering more ideas and knowledge about know-hows.
Planned additions to bspwm-wiki include:
- References and explanations for community bspwm configurations
- Short tips and tricks for common bspwm workflows
- A dedicated query/reference page for
bspcusage - Example configurations for various use cases and setups
This list will evolve as the documentation grows.
Spotted something unclear?
Have a better explanation, fix, or example?
Think that this documentation should reach more people? Give this repository a star and help us hack the github algorithm.
Improvements and issues are welcome. See CONTRIBUTING.md for details.
This project follows a Code of Conduct.
By participating, you agree to uphold it.
This project is licensed under the MIT License — see LICENSE.
Please see SECURITY.md for reporting security issues.
Need to get in touch with latest documentation updates? See CHANGELOG.md for recent changes.