Skip to content

Commit 8391b17

Browse files
adonovangopherbot
authored andcommitted
gopls/doc: document Zed editor
Change-Id: Iffa8a5555491c81e43d7f689ec56dcd189dc660a Reviewed-on: https://go-review.googlesource.com/c/tools/+/686917 Auto-Submit: Alan Donovan <[email protected]> LUCI-TryBot-Result: Go LUCI <[email protected]> Reviewed-by: Robert Findley <[email protected]>
1 parent 778fe21 commit 8391b17

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

gopls/doc/editor/zed.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Gopls: Using Zed"
3+
---
4+
5+
## Install `gopls`
6+
7+
To use `gopls` with [Zed](https://zed.dev/), first
8+
[install the `gopls` executable](../index.md#installation) and ensure that the directory
9+
containing the resulting binary (either `$(go env GOBIN)` or `$(go env
10+
GOPATH)/bin`) is in your `PATH`.
11+
12+
## That's it
13+
14+
Zed has a built-in LSP client and knows to run `gopls` when visiting a
15+
Go source file, so most features work right out of the box.
16+
17+
Zed does not yet support external `window/showDocument` requests,
18+
so web-based features will not work;
19+
see [Zed issue 24852](https://github.com/zed-industries/zed/discussions/24852).

gopls/doc/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ To get started with `gopls`, install an LSP plugin in your editor of choice.
4949
* [Sublime Text](editor/sublime.md)
5050
* [VS Code](https://github.com/golang/vscode-go/blob/master/README.md)
5151
* [Vim or Neovim](editor/vim.md)
52+
* [Zed](editor/zed.md)
5253

5354
If you use `gopls` with an editor that is not on this list, please send us a CL
5455
[updating this documentation](contributing.md).

0 commit comments

Comments
 (0)