Skip to content

Commit f99b715

Browse files
authored
Zed Docs (#2345)
1 parent 9cb6297 commit f99b715

File tree

5 files changed

+7469
-5743
lines changed

5 files changed

+7469
-5743
lines changed

docs/app/.envrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
#!/bin/bash
2+
13
# Automatically sets up your devbox environment whenever you cd into this
24
# directory via our direnv integration:
35

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Zed Editor
3+
---
4+
5+
[Zed](https://zed.dev/) is a fast, open source code editor designed for collaboration and AI support, that is available for macOS and Linux. Zed has support for loading environments directly from Direnv's `.envrc` files, meaning you can easily use Zed w/ Devbox via our [direnv integration](/devbox/ide_configuration/direnv).
6+
7+
## Setting up your Project for Zed
8+
9+
1. Make sure that you have direnv installed on your host. To use direnv across all your projects, we recommend installing it with [devbox global](/devbox/devbox_global) using `devbox global add direnv`. You can also follow [this guide](https://direnv.net/#basic-installation) to configure direnv for your system
10+
11+
2. Generate a `.envrc` file for your project by running `devbox generate direnv` in your project's root directory (the same directory with your `devbox.json` file.
12+
13+
3. You can now open your project in Zed and it will automatically load your Devbox shell environment variables from the `.envrc` file.
14+
15+
## Troubleshooting your Zed Setup
16+
17+
If you are having trouble getting Zed's LSP to detect your Devbox environment, try the following steps:
18+
19+
1. Make sure you are up to date with the latest version of Zed. You can check for updates by going to `Zed > Check for Updates` in the Zed menu.
20+
21+
2. You may need to explicitly tell your LSP to use the binaries in your $PATH variable. To do this, add the following to the `~/.config/zed/config.json` file:
22+
23+
```json
24+
{
25+
...
26+
"lsp": {
27+
"<lsp-name>": {
28+
"binary": {"path_lookup": true}
29+
}
30+
},
31+
...
32+
}
33+
```
34+
35+
3. If you have a version of the binary/language server installed on your host machine, Zed's default behavior for loading direnv directly may cause conflicts with the packages installed via Devbox. To fix this, add the following to your `~/.config/zed/config.json` file:
36+
37+
```json
38+
{
39+
"load_direnv": "shell_hook"
40+
}
41+
```

docs/app/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "devbox",
33
"version": "0.0.0",
44
"private": true,
5-
"packageManager": "pnpm@8.15.9",
5+
"packageManager": "pnpm@9.12.1",
66
"scripts": {
77
"docusaurus": "docusaurus",
88
"start": "docusaurus start",

0 commit comments

Comments
 (0)