Official documentation for quickshell
Go to file
outfoxxed b218d3ec30
build: add nix package
2024-03-09 06:28:20 -08:00
assets/css feat: add QML overview 2024-03-07 05:30:01 -08:00
content build: add nix package 2024-03-09 06:28:20 -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 build: add nix package 2024-03-09 06:28:20 -08:00
types initial commit 2024-02-12 04:07:01 -08:00
.gitignore build: add nix package 2024-03-09 06:28:20 -08:00
.gitmodules initial commit 2024-02-12 04:07:01 -08:00
Justfile build: add nix package 2024-03-09 06:28:20 -08:00
README.md docs: add build instructions to README 2024-03-07 06:18:28 -08:00
default.nix build: add nix package 2024-03-09 06:28:20 -08:00
flake.lock build: add nix package 2024-03-09 06:28:20 -08:00
flake.nix build: add nix package 2024-03-09 06:28:20 -08:00
hugo.toml build: add nix package 2024-03-09 06:28:20 -08:00
package.nix build: add nix package 2024-03-09 06:28:20 -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