Official documentation for quickshell
Go to file
outfoxxed 70989dc619
guide: mention quickshell-examples
2024-03-08 04:37:37 -08:00
assets/css feat: add QML overview 2024-03-07 05:30:01 -08:00
content guide: mention quickshell-examples 2024-03-08 04:37:37 -08:00
layouts fix: module listing descriptions 2024-02-26 00:32:03 -08:00
themes initial commit 2024-02-12 04:07:01 -08:00
typegen fix: make qmap parseable (but still not a type) 2024-03-03 19:31:35 -08:00
types initial commit 2024-02-12 04:07:01 -08:00
.gitignore rename: QuickShell => Quickshell 2024-02-26 00:57:10 -08:00
.gitmodules initial commit 2024-02-12 04:07:01 -08:00
Justfile feat: add Io module 2024-03-03 01:58:33 -08:00
README.md docs: add build instructions to README 2024-03-07 06:18:28 -08:00
hugo.toml rename: QuickShell => Quickshell 2024-02-26 00:57:10 -08:00
shell.nix initial commit 2024-02-12 04:07:01 -08:00

README.md

quickshell-docs

Documentation for quickshell.

Building the documentation

The docs depend on:

  • just
  • hugo
  • rust

To build the documentation you must be in a subdirectory of the main quickshell repo, which is where the submodule clones this repo.

Run the following command to build and serve the docs locally:

$ just serve