mirror of
https://github.com/zed-industries/zed.git
synced 2025-02-09 12:01:58 +00:00
docs: Format docs (#15352)
This PR formats the rest of the docs' source files. I'll follow up with a CI check to ensure they stay formatted. Release Notes: - N/A
This commit is contained in:
parent
53a3d6424f
commit
3a44a59f8e
13 changed files with 85 additions and 79 deletions
|
@ -22,7 +22,6 @@ Clone down the [Zed repository](https://github.com/zed-industries/zed).
|
|||
|
||||
## Backend dependencies
|
||||
|
||||
> [!WARNING]
|
||||
> This section is still in development. The instructions are not yet complete.
|
||||
|
||||
If you are developing collaborative features of Zed, you'll need to install the dependencies of zed's `collab` server:
|
||||
|
@ -70,7 +69,7 @@ This will build zed and the cli in release mode and make them available at `~/.l
|
|||
|
||||
## Wayland & X11
|
||||
|
||||
Zed supports both X11 and Wayland. By default, we pick whichever we can find at runtime. If you're on Wayland and want to run in X11 mode, use the environment variable `WAYLAND_DISPLAY=''`.
|
||||
Zed supports both X11 and Wayland. By default, we pick whichever we can find at runtime. If you're on Wayland and want to run in X11 mode, use the environment variable `WAYLAND_DISPLAY=''`.
|
||||
|
||||
## Notes for packaging Zed
|
||||
|
||||
|
@ -80,13 +79,13 @@ Thank you for taking on the task of packaging Zed!
|
|||
|
||||
Zed has two main binaries:
|
||||
|
||||
* You will need to build `crates/cli` and make it's binary available in `$PATH` with the name `zed`.
|
||||
* You will need to build `crates/zed` and put it at `$PATH/to/cli/../../libexec/zed-editor`. For example, if you are going to put the cli at `~/.local/bin/zed` put zed at `~/.local/libexec/zed-editor`. As some linux distributions (notably Arch) discourage the use of `libexec`, you can also put this binary at `$PATH/to/cli/../../lib/zed/zed-editor` (e.g. `~/.local/lib/zed/zed-editor`) instead.
|
||||
* If you are going to provide a `.desktop` file you can find a template in `crates/zed/resources/zed.desktop.in`, and use `envsubst` to populate it with the values required. This file should also be renamed to `$APP_ID.desktop` so that the file [follows the FreeDesktop standards](https://github.com/zed-industries/zed/issues/12707#issuecomment-2168742761).
|
||||
* You will need to ensure that the necessary libraries are installed. You can get the current list by [inspecting the built binary](https://github.com/zed-industries/zed/blob/059a4141b756cf4afac4c977afc488539aec6470/script/bundle-linux#L65-L70) on your system.
|
||||
* For an example of a complete build script, see [script/bundle-linux](https://github.com/zed-industries/zed/blob/main/script/bundle-linux).
|
||||
* You can disable Zed's auto updates and provide instructions for users who try to update Zed manually by building (or running) Zed with the environment variable `ZED_UPDATE_EXPLANATION`. For example: `ZED_UPDATE_EXPLANATION="Please use flatpak to update zed."`.
|
||||
* Make sure to update the contents of the `crates/zed/RELEASE_CHANNEL` file to 'nightly', 'preview', or 'stable', with no newline. This will cause Zed to use the credentials manager to remember a user's login.
|
||||
- You will need to build `crates/cli` and make it's binary available in `$PATH` with the name `zed`.
|
||||
- You will need to build `crates/zed` and put it at `$PATH/to/cli/../../libexec/zed-editor`. For example, if you are going to put the cli at `~/.local/bin/zed` put zed at `~/.local/libexec/zed-editor`. As some linux distributions (notably Arch) discourage the use of `libexec`, you can also put this binary at `$PATH/to/cli/../../lib/zed/zed-editor` (e.g. `~/.local/lib/zed/zed-editor`) instead.
|
||||
- If you are going to provide a `.desktop` file you can find a template in `crates/zed/resources/zed.desktop.in`, and use `envsubst` to populate it with the values required. This file should also be renamed to `$APP_ID.desktop` so that the file [follows the FreeDesktop standards](https://github.com/zed-industries/zed/issues/12707#issuecomment-2168742761).
|
||||
- You will need to ensure that the necessary libraries are installed. You can get the current list by [inspecting the built binary](https://github.com/zed-industries/zed/blob/059a4141b756cf4afac4c977afc488539aec6470/script/bundle-linux#L65-L70) on your system.
|
||||
- For an example of a complete build script, see [script/bundle-linux](https://github.com/zed-industries/zed/blob/main/script/bundle-linux).
|
||||
- You can disable Zed's auto updates and provide instructions for users who try to update Zed manually by building (or running) Zed with the environment variable `ZED_UPDATE_EXPLANATION`. For example: `ZED_UPDATE_EXPLANATION="Please use flatpak to update zed."`.
|
||||
- Make sure to update the contents of the `crates/zed/RELEASE_CHANNEL` file to 'nightly', 'preview', or 'stable', with no newline. This will cause Zed to use the credentials manager to remember a user's login.
|
||||
|
||||
### Other things to note
|
||||
|
||||
|
@ -94,16 +93,15 @@ At Zed, our priority has been to move fast and bring the latest technology to ou
|
|||
|
||||
However, we realize that many distros have other priorities. We want to work with everyone to bring Zed to their favorite platforms. But there is a long way to go:
|
||||
|
||||
* Zed is a fast-moving early-phase project. We typically release 2-3 builds per week to fix user-reported issues and release major features.
|
||||
* There are a couple of other `zed` binaries that may be present on Linux systems ([1](https://openzfs.github.io/openzfs-docs/man/v2.2/8/zed.8.html), [2](https://zed.brimdata.io/docs/commands/zed)). If you want to rename our CLI binary because of these issues, we suggest `zedit`, `zeditor`, or `zed-cli`.
|
||||
* Zed automatically installs the correct version of common developer tools in the same way as rustup/rbenv/pyenv, etc. We understand this is contentious, [see here](https://github.com/zed-industries/zed/issues/12589).
|
||||
* We allow users to install extensions locally and from [zed-industries/extensions](https://github.com/zed-industries/extensions). These extensions may install further tooling as needed, such as language servers. In the long run, we would like to make this safer, [see here](https://github.com/zed-industries/zed/issues/12358).
|
||||
* Zed connects to several online services by default (AI, telemetry, collaboration). AI and our telemetry can be disabled by your users with their zed settings or by patching our [default settings file](https://github.com/zed-industries/zed/blob/main/assets/settings/default.json).
|
||||
* As a result of the above issues, zed currently does not play nice with sandboxes, [see here](https://github.com/zed-industries/zed/pull/12006#issuecomment-2130421220)
|
||||
- Zed is a fast-moving early-phase project. We typically release 2-3 builds per week to fix user-reported issues and release major features.
|
||||
- There are a couple of other `zed` binaries that may be present on Linux systems ([1](https://openzfs.github.io/openzfs-docs/man/v2.2/8/zed.8.html), [2](https://zed.brimdata.io/docs/commands/zed)). If you want to rename our CLI binary because of these issues, we suggest `zedit`, `zeditor`, or `zed-cli`.
|
||||
- Zed automatically installs the correct version of common developer tools in the same way as rustup/rbenv/pyenv, etc. We understand this is contentious, [see here](https://github.com/zed-industries/zed/issues/12589).
|
||||
- We allow users to install extensions locally and from [zed-industries/extensions](https://github.com/zed-industries/extensions). These extensions may install further tooling as needed, such as language servers. In the long run, we would like to make this safer, [see here](https://github.com/zed-industries/zed/issues/12358).
|
||||
- Zed connects to several online services by default (AI, telemetry, collaboration). AI and our telemetry can be disabled by your users with their zed settings or by patching our [default settings file](https://github.com/zed-industries/zed/blob/main/assets/settings/default.json).
|
||||
- As a result of the above issues, zed currently does not play nice with sandboxes, [see here](https://github.com/zed-industries/zed/pull/12006#issuecomment-2130421220)
|
||||
|
||||
## Flatpak
|
||||
|
||||
> [!WARNING]
|
||||
> Zed's current Flatpak integration exits the sandbox on startup. Workflows that rely on Flatpak's sandboxing may not work as expected.
|
||||
|
||||
To build & install the Flatpak package locally follow the steps below:
|
||||
|
|
|
@ -1,6 +1,5 @@
|
|||
# Building Zed for Windows
|
||||
|
||||
> [!NOTE]
|
||||
> The following commands may be executed in any shell.
|
||||
|
||||
## Repository
|
||||
|
@ -23,12 +22,10 @@ Clone down the [Zed repository](https://github.com/zed-industries/zed).
|
|||
|
||||
- Install [Visual Studio](https://visualstudio.microsoft.com/downloads/) with optional component `MSVC v*** - VS YYYY C++ x64/x86 build tools` and install Windows 11 or 10 SDK depending on your system
|
||||
|
||||
> [!NOTE]
|
||||
> `v***` is your VS version and `YYYY` is year when your VS was released.
|
||||
|
||||
## Backend dependencies
|
||||
|
||||
> [!WARNING]
|
||||
> This section is still in development. The instructions are not yet complete.
|
||||
|
||||
If you are developing collaborative features of Zed, you'll need to install the dependencies of zed's `collab` server:
|
||||
|
@ -75,7 +72,6 @@ pacman -S mingw-w64-ucrt-x86_64-zed
|
|||
|
||||
then you can run `zed` in a UCRT64 shell.
|
||||
|
||||
> [!NOTE]
|
||||
> Please, report any issue in https://github.com/msys2/MINGW-packages/issues first.
|
||||
|
||||
## Troubleshooting
|
||||
|
|
|
@ -52,7 +52,7 @@ The Command Palette allows you to access pretty much any functionality that's av
|
|||
|
||||
Try it! Open the Command Palette and type in `new file`. You should see the list of commands being filtered down to `workspace: new file`. Hit return and you end up with a new buffer!
|
||||
|
||||
Any time you see instructions that include commands of the form `zed: ...` or `editor: ...` and so on that means you need to execute them in the Command Palette.
|
||||
Any time you see instructions that include commands of the form `zed: ...` or `editor: ...` and so on that means you need to execute them in the Command Palette.
|
||||
|
||||
## Configure Zed
|
||||
|
||||
|
@ -66,4 +66,4 @@ On Linux, you can access the default configuration via the Command Palette. Open
|
|||
|
||||
On macOS, you can access the default key binding set using the `Zed > Settings > Open Default Key Bindings` menu item. Use `⌘` + `K`, `⌘` + `S` to open your custom keymap to add your key bindings. See Key Bindings for more info.
|
||||
|
||||
On Linux, you can access the default key bindings via the Command Palette. Open it with `ctrl-shift-p` and type in `zed: open default keymap` and then hit return.
|
||||
On Linux, you can access the default key bindings via the Command Palette. Open it with `ctrl-shift-p` and type in `zed: open default keymap` and then hit return.
|
||||
|
|
|
@ -50,7 +50,7 @@ Zed has the ability to match against not just a single keypress, but a sequence
|
|||
Each key press is a sequence of modifiers followed by a key. The modifiers are:
|
||||
|
||||
- `ctrl-` The control key
|
||||
* `cmd-`, `win-` or `super-` for the platform modifier (Command on macOS, Windows key on Windows, and the Super key on Linux).
|
||||
- `cmd-`, `win-` or `super-` for the platform modifier (Command on macOS, Windows key on Windows, and the Super key on Linux).
|
||||
- `alt-` for alt (option on macOS)
|
||||
- `shift-` The shift key
|
||||
- `fn-` The function key
|
||||
|
@ -160,7 +160,7 @@ See the [tasks documentation](/docs/tasks#custom-keybindings-for-tasks) for more
|
|||
| Open | Workspace | `⌘ + O` |
|
||||
| Toggle zoom | Workspace | `Shift + Escape` |
|
||||
| Debug elements | Zed | `⌘ + Alt + I` |
|
||||
| Decrease buffer font size | Zed | `⌘ + -` |
|
||||
| Decrease buffer font size | Zed | `⌘ + -` |
|
||||
| Hide | Zed | `⌘ + H` |
|
||||
| Hide others | Zed | `Alt + ⌘ + H` |
|
||||
| Increase buffer font size | Zed | `⌘ + +` |
|
||||
|
|
|
@ -100,13 +100,17 @@ The custom URL here is `http://localhost:11434/v1`.
|
|||
You can use Ollama with the Zed assistant by making Ollama appear as an OpenAPI endpoint.
|
||||
|
||||
1. Download, for example, the `mistral` model with Ollama:
|
||||
```
|
||||
ollama pull mistral
|
||||
```
|
||||
|
||||
```
|
||||
ollama pull mistral
|
||||
```
|
||||
|
||||
2. Make sure that the Ollama server is running. You can start it either via running the Ollama app, or launching:
|
||||
```
|
||||
ollama serve
|
||||
```
|
||||
|
||||
```
|
||||
ollama serve
|
||||
```
|
||||
|
||||
3. In the assistant panel, select one of the Ollama models using the model dropdown.
|
||||
4. (Optional) If you want to change the default url that is used to access the Ollama server, you can do so by adding the following settings:
|
||||
|
||||
|
|
|
@ -143,6 +143,6 @@ You can configure ESLint's `rulesCustomizations` setting:
|
|||
}
|
||||
```
|
||||
|
||||
|
||||
## Yarn integration
|
||||
|
||||
See [Yarn documentation](./yarn.md) for a walkthrough of configuring your project to use Yarn.
|
||||
|
|
|
@ -4,12 +4,12 @@ R support is available through the [R extension](https://github.com/ocsmit/zed-r
|
|||
|
||||
## Installation
|
||||
|
||||
* [Install R](https://cloud.r-project.org/)
|
||||
* Install the R packages `languageserver` and `lintr`:
|
||||
- [Install R](https://cloud.r-project.org/)
|
||||
- Install the R packages `languageserver` and `lintr`:
|
||||
|
||||
```R
|
||||
install.packages("languageserver")
|
||||
install.packages("lintr")
|
||||
```
|
||||
|
||||
* Install the [R extension](https://github.com/ocsmit/zed-r) through Zed's extensions
|
||||
- Install the [R extension](https://github.com/ocsmit/zed-r) through Zed's extensions
|
||||
|
|
|
@ -44,4 +44,5 @@ to override these settings.
|
|||
See https://github.com/typescript-language-server/typescript-language-server?tab=readme-ov-file#inlay-hints-textdocumentinlayhint for more information.
|
||||
|
||||
## Yarn integration
|
||||
|
||||
See [Yarn documentation](./yarn.md) for a walkthrough of configuring your project to use Yarn.
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
# Yarn
|
||||
|
||||
[Yarn](https://yarnpkg.com/) is a versatile package manager that improves dependency management and workflow efficiency for JavaScript and other languages. It ensures a deterministic dependency tree, offers offline support, and enhances security for reliable builds.
|
||||
|
||||
## Setup
|
||||
|
|
|
@ -13,10 +13,11 @@ curl -f https://zed.dev/install.sh | ZED_CHANNEL=preview sh
|
|||
```
|
||||
|
||||
The Zed installed by the script does not work on systems that:
|
||||
* have no Vulkan compatible GPU available (for example Linux on an M-series macBook)
|
||||
* have no system-wide glibc (for example on NixOS or Alpine by default)
|
||||
* have a glibc older than version 2.29 (for example Amazon Linux 2 or Ubuntu 18 and earlier)
|
||||
* use an architecture other than 64-bit Intel or 64-bit ARM (for example a 32-bit or RISC-V machine)
|
||||
|
||||
- have no Vulkan compatible GPU available (for example Linux on an M-series macBook)
|
||||
- have no system-wide glibc (for example on NixOS or Alpine by default)
|
||||
- have a glibc older than version 2.29 (for example Amazon Linux 2 or Ubuntu 18 and earlier)
|
||||
- use an architecture other than 64-bit Intel or 64-bit ARM (for example a 32-bit or RISC-V machine)
|
||||
|
||||
Both Nix and Alpine have third-party Zed packages available (though they are currently a few weeks out of date). If you'd like to use our builds they do work if you install a glibc compatibility layer. On NixOS you can try [nix-ld](https://github.com/Mic92/nix-ld), and on Alpine [gcompat](https://wiki.alpinelinux.org/wiki/Running_glibc_programs).
|
||||
|
||||
|
@ -28,19 +29,19 @@ Zed is open source, and [you can install from source](./development/linux.md).
|
|||
|
||||
There are several third-party Zed packages for various Linux distributions and package managers, sometimes under `zed-editor`. You may be able to install Zed using these packages:
|
||||
|
||||
* Homebrew: [`zed`](https://formulae.brew.sh/cask/zed), [`zed@preview`](https://formulae.brew.sh/cask/zed@preview)
|
||||
* Arch: [`zed`](https://archlinux.org/packages/extra/x86_64/zed/)
|
||||
* Arch (AUR): [`zed-git`](https://aur.archlinux.org/packages/zed-git), [`zed-preview`](https://aur.archlinux.org/packages/zed-preview), [`zed-preview-bin`](https://aur.archlinux.org/packages/zed-preview-bin)
|
||||
* Alpine: `zed` ([aarch64](https://pkgs.alpinelinux.org/package/edge/testing/aarch64/zed)) ([x86_64](https://pkgs.alpinelinux.org/package/edge/testing/x86_64/zed))
|
||||
* Nix: `zed-editor` ([stable](https://search.nixos.org/packages?show=zed-editor)), ([unstable](https://search.nixos.org/packages?channel=unstable&show=zed-editor))
|
||||
* Fedora/Ultramarine (Terra): [`zed`](https://github.com/terrapkg/packages/tree/frawhide/anda/devs/zed/stable), [`zed-preview`](https://github.com/terrapkg/packages/tree/frawhide/anda/devs/zed/preview), [`zed-nightly`](https://github.com/terrapkg/packages/tree/frawhide/anda/devs/zed/nightly)
|
||||
* Solus: [`zed`](https://github.com/getsolus/packages/tree/main/packages/z/zed)
|
||||
* Parabola: [`zed`](https://www.parabola.nu/packages/extra/x86_64/zed/)
|
||||
* Manjaro: [`zed`](https://packages.manjaro.org/?query=zed)
|
||||
* ALT Linux (Sisyphus): [`zed`](https://packages.altlinux.org/en/sisyphus/srpms/zed/)
|
||||
* AOSC OS: [`zed`](https://packages.aosc.io/packages/zed)
|
||||
* openSUSE Tumbleweed: [`zed`](https://en.opensuse.org/Zed)
|
||||
* Please add others to this list!
|
||||
- Homebrew: [`zed`](https://formulae.brew.sh/cask/zed), [`zed@preview`](https://formulae.brew.sh/cask/zed@preview)
|
||||
- Arch: [`zed`](https://archlinux.org/packages/extra/x86_64/zed/)
|
||||
- Arch (AUR): [`zed-git`](https://aur.archlinux.org/packages/zed-git), [`zed-preview`](https://aur.archlinux.org/packages/zed-preview), [`zed-preview-bin`](https://aur.archlinux.org/packages/zed-preview-bin)
|
||||
- Alpine: `zed` ([aarch64](https://pkgs.alpinelinux.org/package/edge/testing/aarch64/zed)) ([x86_64](https://pkgs.alpinelinux.org/package/edge/testing/x86_64/zed))
|
||||
- Nix: `zed-editor` ([stable](https://search.nixos.org/packages?show=zed-editor)), ([unstable](https://search.nixos.org/packages?channel=unstable&show=zed-editor))
|
||||
- Fedora/Ultramarine (Terra): [`zed`](https://github.com/terrapkg/packages/tree/frawhide/anda/devs/zed/stable), [`zed-preview`](https://github.com/terrapkg/packages/tree/frawhide/anda/devs/zed/preview), [`zed-nightly`](https://github.com/terrapkg/packages/tree/frawhide/anda/devs/zed/nightly)
|
||||
- Solus: [`zed`](https://github.com/getsolus/packages/tree/main/packages/z/zed)
|
||||
- Parabola: [`zed`](https://www.parabola.nu/packages/extra/x86_64/zed/)
|
||||
- Manjaro: [`zed`](https://packages.manjaro.org/?query=zed)
|
||||
- ALT Linux (Sisyphus): [`zed`](https://packages.altlinux.org/en/sisyphus/srpms/zed/)
|
||||
- AOSC OS: [`zed`](https://packages.aosc.io/packages/zed)
|
||||
- openSUSE Tumbleweed: [`zed`](https://en.opensuse.org/Zed)
|
||||
- Please add others to this list!
|
||||
|
||||
When installing a third-party package please be aware that it may not be completely up to date and may be slightly different from the Zed we package (a common change is to rename the binary to `zedit` or `zeditor` to avoid conflicting with other packages).
|
||||
|
||||
|
@ -52,9 +53,9 @@ If you'd prefer, you can install Zed by downloading our pre-built .tar.gz. This
|
|||
|
||||
Download the `.tar.gz` file:
|
||||
|
||||
* [zed-linux-x86_64.tar.gz](https://zed.dev/api/releases/stable/latest/zed-linux-x86_64.tar.gz) ([preview](https://zed.dev/api/releases/preview/latest/zed-linux-x86_64.tar.gz))
|
||||
* [zed-linux-aarch64.tar.gz](https://zed.dev/api/releases/stable/latest/zed-linux-aarch64.tar.gz)
|
||||
([preview](https://zed.dev/api/releases/preview/latest/zed-linux-aarch64.tar.gz))
|
||||
- [zed-linux-x86_64.tar.gz](https://zed.dev/api/releases/stable/latest/zed-linux-x86_64.tar.gz) ([preview](https://zed.dev/api/releases/preview/latest/zed-linux-x86_64.tar.gz))
|
||||
- [zed-linux-aarch64.tar.gz](https://zed.dev/api/releases/stable/latest/zed-linux-aarch64.tar.gz)
|
||||
([preview](https://zed.dev/api/releases/preview/latest/zed-linux-aarch64.tar.gz))
|
||||
|
||||
Then ensure that the `zed` binary in the tarball is on your path. The easiest way is to unpack the tarball and create a symlink:
|
||||
|
||||
|
@ -83,6 +84,7 @@ Linux works on a large variety of systems configured in many different ways. We
|
|||
If you see an error like "/lib64/libc.so.6: version 'GLIBC_2.29' not found" it means that your distribution's version of glibc is too old. You can either upgrade your system, or [install Zed from source](./development/linux.md).
|
||||
|
||||
### Zed fails to open windows
|
||||
|
||||
### Zed is very slow
|
||||
|
||||
Zed requires a GPU to run effectively. Under the hood, we use [Vulkan](https://www.vulkan.org/) to communicate with your GPU. If you are seeing problems with performance, or Zed fails to load, it is possible that Vulkan is the culprit.
|
||||
|
@ -112,7 +114,9 @@ For more information, the [Arch guide to Vulkan](https://wiki.archlinux.org/titl
|
|||
If Vulkan is configured correctly, and Zed is still slow for you, please [file an issue](https://github.com/zed-industries/zed) with as much information as possible.
|
||||
|
||||
### I can't open any files
|
||||
|
||||
### Zed isn't remembering my login
|
||||
|
||||
### Clicking links isn't working
|
||||
|
||||
All of these features are provided by XDG desktop portals, specifically:
|
||||
|
@ -128,7 +132,8 @@ Some window managers, such as `Hyprland`, don't provide a file picker by default
|
|||
Zed relies on inotify to watch your filesystem for changes. If you cannot start inotify then Zed will not work reliably.
|
||||
|
||||
If you are seeing "too many open files" then first try `sysctl fs.inotify`.
|
||||
* You should see that max_user_instances is 128 or higher (you can change the limit with `sudo sysctl fs.inotify.max_user_instances=1024`). Zed needs only 1 inotify instance.
|
||||
* You should see that `max_user_watches` is 8000 or higher (you can change the limit with `sudo sysctl fs.inotify.max_user_watches=64000`). Zed needs one watch per directory in all your open projects + one per git repository + a handful more for settings, themes, keymaps, extensions.
|
||||
|
||||
- You should see that max_user_instances is 128 or higher (you can change the limit with `sudo sysctl fs.inotify.max_user_instances=1024`). Zed needs only 1 inotify instance.
|
||||
- You should see that `max_user_watches` is 8000 or higher (you can change the limit with `sudo sysctl fs.inotify.max_user_watches=64000`). Zed needs one watch per directory in all your open projects + one per git repository + a handful more for settings, themes, keymaps, extensions.
|
||||
|
||||
It is also possible that you are running out of file descriptors. You can check the limits with `ulimit` and update them by editing `/etc/security/limits.conf`.
|
||||
|
|
|
@ -14,11 +14,11 @@ Currently the two instances connect via Zed's servers, but we intend to build pe
|
|||
|
||||
1. Download and install the latest [Zed Preview](https://zed.dev/releases/preview).
|
||||
1. Open the remote projects dialogue with `cmd-shift-p remote`.
|
||||
2. Click "New Server".
|
||||
3. Choose whether to setup via SSH, or to follow the manual setup.
|
||||
1. Click "New Server".
|
||||
1. Choose whether to setup via SSH, or to follow the manual setup.
|
||||
> **Note:** With both options your laptop and the remote machine will communicate
|
||||
via https://collab.zed.dev/, so you will need outbound internet access on the remote machine.
|
||||
6. On your laptop you can now open folders on the remote machine.
|
||||
> via https://collab.zed.dev/, so you will need outbound internet access on the remote machine.
|
||||
1. On your laptop you can now open folders on the remote machine.
|
||||
> **Note:** Zed does not currently handle opening very large directories (for example, `/` or `~` that may have >100,000 files) very well. We are working on improving this, but suggest in the meantime opening only specific projects, or subfolders of very large mono-repos.
|
||||
|
||||
## Troubleshooting
|
||||
|
@ -106,6 +106,7 @@ zed ssh://user@host:port/path/to/project
|
|||
```
|
||||
|
||||
Or you can (in your settings file) add:
|
||||
|
||||
```
|
||||
"ssh_connections": []
|
||||
```
|
||||
|
|
|
@ -27,8 +27,8 @@ Zed supports running code in multiple languages. To get started, you need to ins
|
|||
|
||||
**Currently supported languages:**
|
||||
|
||||
* [Python (ipykernel)](#python)
|
||||
* [TypeScript (Deno)](#typescript-deno)
|
||||
- [Python (ipykernel)](#python)
|
||||
- [TypeScript (Deno)](#typescript-deno)
|
||||
|
||||
Once installed, you can start using the REPL in the respective language files, or other places those languages are supported, such as Markdown. If you recently added the kernels, run the `repl: refresh kernelspecs` command to make them available in the editor.
|
||||
|
||||
|
@ -105,18 +105,18 @@ deno jupyter --install
|
|||
|
||||
The following languages and kernels are also supported. You can help us out by expanding their installation instructions and configuration:
|
||||
|
||||
* [Julia (IJulia)](https://github.com/JuliaLang/IJulia.jl)
|
||||
* R
|
||||
- [Julia (IJulia)](https://github.com/JuliaLang/IJulia.jl)
|
||||
- R
|
||||
- [Ark Kernel](https://github.com/posit-dev/ark) - via Positron, formerly RStudio
|
||||
- [Xeus-R](https://github.com/jupyter-xeus/xeus-r)
|
||||
* [Scala (almond)](https://almond.sh/docs/quick-start-install)
|
||||
- [Scala (almond)](https://almond.sh/docs/quick-start-install)
|
||||
|
||||
## Changing which kernel is used per language {#changing-kernels}
|
||||
|
||||
Zed automatically detects the available kernels on your system. If you need to configure a different default kernel for a
|
||||
language, you can assign a kernel for any supported language in your `settings.json`.
|
||||
|
||||
```jsonc
|
||||
```json
|
||||
{
|
||||
"jupyter": {
|
||||
"kernel_selections": {
|
||||
|
|
|
@ -124,9 +124,9 @@ Zed's keyboard bindings are evaluated only when the `"context"` matches the loca
|
|||
|
||||
Vim mode adds several contexts to the `Editor`:
|
||||
|
||||
* `vim_mode` is similar to, but not identical to, the current mode. It starts as one of `normal`, `visual`, `insert` or `replace` (depending on your mode). If you are mid-way through typing a sequence, `vim_mode` will be either `waiting` if it's waiting for an arbitrary key (for example after typing `f` or `t`), or `operator` if it's waiting for another binding to trigger (for example after typing `c` or `d`).
|
||||
* `vim_operator` is set to `none` unless `vim_mode == operator` in which case it is set to the current operator's default keybinding (for example after typing `d`, `vim_operator == d`).
|
||||
* `"VimControl"` indicates that vim keybindings should work. It is currently an alias for `vim_mode == normal || vim_mode == visual || vim_mode == operator`, but the definition may change over time.
|
||||
- `vim_mode` is similar to, but not identical to, the current mode. It starts as one of `normal`, `visual`, `insert` or `replace` (depending on your mode). If you are mid-way through typing a sequence, `vim_mode` will be either `waiting` if it's waiting for an arbitrary key (for example after typing `f` or `t`), or `operator` if it's waiting for another binding to trigger (for example after typing `c` or `d`).
|
||||
- `vim_operator` is set to `none` unless `vim_mode == operator` in which case it is set to the current operator's default keybinding (for example after typing `d`, `vim_operator == d`).
|
||||
- `"VimControl"` indicates that vim keybindings should work. It is currently an alias for `vim_mode == normal || vim_mode == visual || vim_mode == operator`, but the definition may change over time.
|
||||
|
||||
### Restoring some sense of normality
|
||||
|
||||
|
@ -302,17 +302,17 @@ Subword motion is not enabled by default. To enable it, add these bindings to yo
|
|||
Surrounding the selection in visual mode is also not enabled by default (`shift-s` normally behaves like `c`). To enable it, add the following to your keymap.
|
||||
|
||||
```json
|
||||
{
|
||||
"context": "vim_mode == visual",
|
||||
"bindings": {
|
||||
"shift-s": [
|
||||
"vim::PushOperator",
|
||||
{
|
||||
"AddSurrounds": {}
|
||||
}
|
||||
]
|
||||
}
|
||||
{
|
||||
"context": "vim_mode == visual",
|
||||
"bindings": {
|
||||
"shift-s": [
|
||||
"vim::PushOperator",
|
||||
{
|
||||
"AddSurrounds": {}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Supported plugins
|
||||
|
|
Loading…
Reference in a new issue