rename and reorganize guide pages
This commit is contained in:
parent
b066a48976
commit
02f28202d1
GPG key ID:
4C88A185FB89301E
9 changed files with 14 additions and 19 deletions
|
|
@ -1,152 +0,0 @@
|
|||
---
|
||||
title: "Getting Started"
|
||||
---
|
||||
# {frontmatter.title}
|
||||
> [!NOTE]
|
||||
> Quickshell is still in a somewhat early stage of development.
|
||||
> There will be breaking changes before 1.0, however a migration guide will be provided.
|
||||
|
||||
## Installation
|
||||
|
||||
All packages currently track quickshell's master branch. This may change in the future.
|
||||
|
||||
### Nix
|
||||
The Quickshell repo has an embedded flake.
|
||||
You can use either `git+https://git.outfoxxed.me/outfoxxed/quickshell`
|
||||
or `github:quickshell-mirror/quickshell`.
|
||||
|
||||
```nix
|
||||
{
|
||||
inputs = {
|
||||
nixpkgs.url = "nixpkgs/nixos-unstable";
|
||||
|
||||
quickshell = {
|
||||
url = "git+https://git.outfoxxed.me/outfoxxed/quickshell";
|
||||
|
||||
# THIS IS IMPORTANT
|
||||
# Mismatched system dependencies will lead to crashes and other issues.
|
||||
inputs.nixpkgs.follows = "nixpkgs";
|
||||
};
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
The package is available as `quickshell.packages.<system>.default`, which you can add to
|
||||
`environment.systemPackages` or `home.packages` if you use home-manager.
|
||||
|
||||
### Arch
|
||||
Quickshell is available from the aur by [mcgoth] under
|
||||
the [quickshell](https://aur.archlinux.org/packages/quickshell) package.
|
||||
|
||||
> [!WARNING]
|
||||
> When using the AUR package, quickshell may break any time Qt is updated.
|
||||
> The AUR gives us no way to actually fix this, but Quickshell will attempt to
|
||||
> warn you if it detects a breakage when updating. If warned of a breakage,
|
||||
> please reinstall the package
|
||||
|
||||
Install using the command below:
|
||||
```sh
|
||||
yay -S quickshell
|
||||
```
|
||||
(or your AUR helper of choice)
|
||||
|
||||
### Fedora
|
||||
Quickshell is available from [errornointernet](https://github.com/errornointernet/)'s
|
||||
Fedora COPR as [errornointernet/quickshell](https://copr.fedorainfracloud.org/coprs/errornointernet/quickshell).
|
||||
|
||||
Install using the command below:
|
||||
```sh
|
||||
sudo dnf copr enable errornointernet/quickshell
|
||||
sudo dnf install quickshell
|
||||
```
|
||||
|
||||
## Guix
|
||||
Quickshell's source repository works as a channel. Add the following to your channel list:
|
||||
|
||||
```scheme
|
||||
(channel
|
||||
(name quickshell)
|
||||
(url "https://git.outfoxxed.me/outfoxxed/quickshell")
|
||||
(branch "master"))
|
||||
```
|
||||
|
||||
Then, you can install the package via `guix install quickshell-git` or by adding `quickshell-git` to your system or home definition.
|
||||
|
||||
You can also clone the repository and use `guix shell -f quickshell.scm` to try out the package.
|
||||
|
||||
### Manual build
|
||||
See [BUILD.md](https://git.outfoxxed.me/quickshell/quickshell/src/branch/master/BUILD.md)
|
||||
for build instructions and configurations.
|
||||
|
||||
See [Installation](./installation) if Quickshell isn't installed yet.
|
||||
|
||||
## Editor configuration
|
||||
### Emacs
|
||||
Install the [yuja/tree-sitter-qml](https://github.com/yuja/tree-sitter-qmljs) tree-sitter grammar,
|
||||
and the [xhcoding/qml-ts-mode](https://github.com/xhcoding/qml-ts-mode) mode.
|
||||
|
||||
Both are packaged for nix via [outfoxxed/nix-qml-support](https://git.outfoxxed.me/outfoxxed/nix-qml-support).
|
||||
|
||||
Either `lsp-mode` or `eglot` should be usable for LSP ([caveats below](#language-server)).
|
||||
|
||||
The author's personal emacs config uses `lsp-mode` and `qml-ts-mode` as follows:
|
||||
```elisp
|
||||
(use-package qml-ts-mode
|
||||
:after lsp-mode
|
||||
:config
|
||||
(add-to-list 'lsp-language-id-configuration '(qml-ts-mode . "qml-ts"))
|
||||
(lsp-register-client
|
||||
(make-lsp-client :new-connection (lsp-stdio-connection '("qmlls", "-E"))
|
||||
:activation-fn (lsp-activate-on "qml-ts")
|
||||
:server-id 'qmlls))
|
||||
(add-hook 'qml-ts-mode-hook (lambda ()
|
||||
(setq-local electric-indent-chars '(?\n ?\( ?\) ?{ ?} ?\[ ?\] ?\; ?,))
|
||||
(lsp-deferred))))
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> Qmlls versions prior to 6.8.2 do not require `-E`
|
||||
|
||||
### Neovim
|
||||
Neovim has built-in syntax highlighting for QML, however tree-sitter highlighting
|
||||
may work better than the built-in highlighting. You can install the grammar
|
||||
using `:TSInstall qmljs`.
|
||||
|
||||
To use the language server ([caveats below](#language-server)),
|
||||
install [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig)
|
||||
and the following snippet:
|
||||
|
||||
```lua
|
||||
require("lspconfig").qmlls.setup {
|
||||
cmd = {"qmlls", "-E"}
|
||||
}
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> Qmlls versions prior to 6.8.2 do not require `-E`
|
||||
|
||||
## Language Server
|
||||
The QML language has an associated language server,
|
||||
[qmlls](https://doc.qt.io/qt-6/qtqml-tooling-qmlls.html).
|
||||
Please note that the language server, along with quickshell's support of it,
|
||||
is in development.
|
||||
|
||||
We are aware of the following issues:
|
||||
- Qmlls does not work well when a file is not correctly structured.
|
||||
This means that completions and lints won't work unless braces are closed
|
||||
correctly and such.
|
||||
- Qmlls cannot handle quickshell's singletons. This means you won't see
|
||||
completions, and usages of singleton members may show a warning.
|
||||
We're still investigating this problem and how to fix it.
|
||||
|
||||
Keeping in mind the above caveats, qmlls should be able to guide you towards
|
||||
more correct code should you chose to use it.
|
||||
|
||||
> [!NOTE]
|
||||
> Nix users should note that qmlls will not be able to pick up qml modules
|
||||
> that are not in `QML2_IMPORT_PATH`. The easiest way to ensure this is by setting
|
||||
> `qt.enable` to `true` and installing the quickshell package globally.
|
||||
|
||||
# Next steps
|
||||
|
||||
Create your first configuration by reading the [Intro](/docs/configuration/intro).
|
||||
Loading…
Add table
Add a link
Reference in a new issue