mirror of
https://github.com/zed-industries/zed.git
synced 2026-10-28 08:55:27 +08:00
Fix broken links and stale content in docs (#65490)
## Summary Fixes broken links in `docs/src`. Notes: - **Rego:** pointed to `open-policy-agent/zed-rego` (same extension, moved from `StyraInc`), but it was dropped from the registry in zed-industries/extensions#7599. The Rego page may need removing. - **Roc:** removed `roc_language_server` from setup; the extension now runs `roc experimental-lsp`. - **Meson:** `jobpaardekooper/zed-meson` is the registry's replacement (zed-industries/extensions#4980). - **Removed:** Gemini gemtext (dropped from registry) and the Sweep blog link (site gone, [archived copy](https://web.archive.org/web/20260806152854/https://blog.sweep.dev/posts/oss-next-edit)). ## Testing Ran a link checker over `docs/` and checked each new target by hand. Clicked through the fixed links with `mdbook serve docs`. ## Self-review - [ ] I've reviewed my diff for quality, security, reliability, and performance. - [ ] UI changes follow the [checklist](https://zed.dev/docs/development/ui-checklist). - [ ] Tests cover the new or changed behavior. Used Claude to find and verify the links; I reviewed each change. Release Notes: - N/A --------- Co-authored-by: Smit Barmase <heysmitbarmase@gmail.com>
This commit is contained in:
gusmcgeeandSmit Barmase authored and GitHub committed
1 parent
26363aabdb
commit
8d541bcc9b
17 files changed
+38
-36
No files matched your search
@@ -369,7 +369,7 @@ The `prompt_format` setting controls how code context is formatted for the model
|
||||
- `code_gemma` - CodeGemma format: `<|fim_prefix|>prefix<|fim_suffix|>suffix<|fim_middle|>`
|
||||
- `codestral` - Codestral format: `[SUFFIX]suffix[PREFIX]prefix`
|
||||
- `glm` - GLM-4 format with code markers
|
||||
- `sweep` - [Sweep rewrite-window](https://blog.sweep.dev/posts/oss-next-edit) format using `<|file_sep|>` file blocks for related files, `original/...`, `current/...`, and `updated/...`.
|
||||
- `sweep` - [Sweep Next Edit](https://huggingface.co/sweepai/sweep-next-edit-1.5B/blob/main/run_model.py) rewrite-window format using `<|file_sep|>` file blocks for related files, `original/...`, `current/...`, and `updated/...`.
|
||||
- `infer` - Auto-detect from model name (default)
|
||||
|
||||
With `"prompt_format": "infer"`, Zed automatically uses Zeta 2 format for models named `zeta2` and Zeta 2.1 format for models named `zeta2.1`.
|
||||
|
||||
@@ -8,7 +8,7 @@ description: Zed's code completions from language servers and edit predictions.
|
||||
Zed supports two sources for completions:
|
||||
|
||||
1. "Code Completions" provided by Language Servers (LSPs) automatically installed by Zed or via [Zed Language Extensions](languages.md).
|
||||
2. "Edit Predictions" provided by Zed's own Zeta model or by external providers like [GitHub Copilot](#github-copilot).
|
||||
2. "Edit Predictions" provided by Zed's own Zeta model or by external providers like [GitHub Copilot](./ai/edit-prediction.md#github-copilot).
|
||||
|
||||
## Language Server Code Completions {#code-completions}
|
||||
|
||||
|
||||
@@ -15,10 +15,10 @@ Release Notes:
|
||||
- N/A _or_ Added/Fixed/Improved ...
|
||||
```
|
||||
|
||||
On Wednesdays, we run [`get-preview-channel-changes`](https://github.com/zed-industries/zed/blob/main/script/get-preview-channel-changes), which collects `Release Notes` lines from pull requests landing in preview, as described in the [Release](https://zed.dev/docs/development/release-notes) docs.
|
||||
On Wednesdays, we collect the `Release Notes` lines from pull requests landing in preview to compile the release notes.
|
||||
|
||||
The script outputs everything below the `Release Notes` line, including metadata such as the pull request author (if they are not a Zed team member) and a link to the pull request.
|
||||
If you use `N/A`, the script skips your pull request entirely.
|
||||
Everything below the `Release Notes` line is included, along with metadata such as the pull request author (if they are not a Zed team member) and a link to the pull request.
|
||||
If you use `N/A`, your pull request is skipped entirely.
|
||||
|
||||
## Guidelines for crafting your `Release Notes` line(s)
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ line_comments = ["# "]
|
||||
- `line_comments` is an array of strings that are used to identify line comments in the language. This is used for the `editor::ToggleComments` keybind: {#kb editor::ToggleComments} for toggling lines of code.
|
||||
- `tab_size` defines the indentation/tab size used for this language (default is `4`).
|
||||
- `hard_tabs` whether to indent with tabs (`true`) or spaces (`false`, the default).
|
||||
- `first_line_pattern` is a regular expression that can be used alongside `path_suffixes` (above) or `file_types` in settings to match files that should use this language. For example, Zed uses this to identify Shell Scripts by matching [shebang lines](https://github.com/zed-industries/zed/blob/main/crates/languages/src/bash/config.toml) in the first line of a script.
|
||||
- `first_line_pattern` is a regular expression that can be used alongside `path_suffixes` (above) or `file_types` in settings to match files that should use this language. For example, Zed uses this to identify Shell Scripts by matching [shebang lines](https://github.com/zed-industries/zed/blob/main/crates/grammars/src/bash/config.toml) in the first line of a script.
|
||||
- `debuggers` is an array of strings that are used to identify debuggers in the language. When launching a debugger's `New Process Modal`, Zed will order available debuggers by the order of entries in this array.
|
||||
|
||||
<!--
|
||||
@@ -380,7 +380,7 @@ For languages with closures, these typically should not count as functions in Ze
|
||||
|
||||
For languages with declarations like C, provide queries that match `@class.around` or `@function.around`. The `if` and `ic` text objects will default to these if there is no inside.
|
||||
|
||||
If you are not sure what to put in textobjects.scm, both [nvim-treesitter-textobjects](https://github.com/nvim-treesitter/nvim-treesitter-textobjects), and the [Helix editor](https://github.com/helix-editor/helix) have queries for many languages. You can refer to the Zed [built-in languages](https://github.com/zed-industries/zed/tree/main/crates/languages/src) to see how to adapt these.
|
||||
If you are not sure what to put in textobjects.scm, both [nvim-treesitter-textobjects](https://github.com/nvim-treesitter/nvim-treesitter-textobjects), and the [Helix editor](https://github.com/helix-editor/helix) have queries for many languages. You can refer to the Zed [built-in languages](https://github.com/zed-industries/zed/tree/main/crates/grammars/src) to see how to adapt these.
|
||||
|
||||
| Capture | Description | Vim mode |
|
||||
| ---------------- | ----------------------------------------------------------------------- | ------------------------------------------------ |
|
||||
|
||||
+2
-2
@@ -375,8 +375,8 @@ Zed can open or copy a permanent link to a file or code selection on your Git ho
|
||||
These links are useful for sharing a specific line or range of lines in a file at a specific commit.
|
||||
|
||||
For the current selection in the editor, use {#action editor::CopyPermalinkToLine} or
|
||||
{#action editor::OpenPermalinkToLine} from the [Command Palette](./getting-started.md#command-palette)
|
||||
(search for `permalink`), via [custom key bindings](./key-bindings.md#custom-key-bindings),
|
||||
{#action editor::OpenPermalinkToLine} from the [Command Palette](./command-palette.md)
|
||||
(search for `permalink`), via [custom key bindings](./key-bindings.md#keymap-editor),
|
||||
or by right-clicking and selecting **Copy Permalink to Line**.
|
||||
|
||||
From a file tab or the Project Panel, you can also **Open File Permalink** or **Copy File Permalink**
|
||||
|
||||
@@ -155,7 +155,7 @@ It's worth noting that attributes are only available on the node they are define
|
||||
|
||||
> Note: Before Zed v0.197.x, the `!` operator only looked at one node at a time, and `>` meant "parent" not "ancestor". This meant that `!Editor` would match the context `Workspace > Pane > Editor`, because (confusingly) the Pane matches `!Editor`, and that `os == macos > Editor` did not match the context `Workspace > Pane > Editor` because of the intermediate `Pane` node.
|
||||
|
||||
If you're using Vim mode, we have information on how [vim modes influence the context](./vim.md#contexts). Helix mode is built on top of Vim mode and uses the same contexts.
|
||||
If you're using Vim mode, we have information on how [vim modes influence the context](./vim.md#selecting-the-correct-context). Helix mode is built on top of Vim mode and uses the same contexts.
|
||||
|
||||
### Actions
|
||||
|
||||
|
||||
@@ -114,7 +114,6 @@ Some work out-of-the-box and others rely on [3rd party extensions](./extensions/
|
||||
- [Exograph](https://github.com/exograph/zed-extension)
|
||||
- [Fortran](https://github.com/Xavier-Maruff/zed-fortran)
|
||||
- [F#](https://github.com/nathanjcollins/zed-fsharp)
|
||||
- [Gemini gemtext](https://github.com/clseibold/gemini-zed)
|
||||
- [Git Firefly](https://github.com/d1y/git_firefly)
|
||||
- [GraphQL](https://github.com/11bit/zed-extension-graphql)
|
||||
- [Groq](https://github.com/juice49/zed-groq)
|
||||
@@ -130,8 +129,8 @@ Some work out-of-the-box and others rely on [3rd party extensions](./extensions/
|
||||
- [Lox](https://github.com/arian81/zed-lox)
|
||||
- [Markdown Oxide](https://github.com/Feel-ix-343/markdown-oxide-zed)
|
||||
- [Marksman](https://github.com/vitallium/zed-marksman)
|
||||
- [Matlab](https://github.com/rzukic/zed-matlab)
|
||||
- [Meson](https://github.com/hqnna/zed-meson)
|
||||
- [Matlab](https://github.com/zed-extensions/matlab)
|
||||
- [Meson](https://github.com/jobpaardekooper/zed-meson)
|
||||
- [Navi](https://github.com/navi-language/zed-navi)
|
||||
- [NeoCMake](https://github.com/k0tran/zed_neocmake)
|
||||
- [Nginx](https://github.com/d1y/nginx-zed)
|
||||
@@ -139,7 +138,7 @@ Some work out-of-the-box and others rely on [3rd party extensions](./extensions/
|
||||
- [Nix](https://github.com/zed-extensions/nix)
|
||||
- [Noir](https://github.com/shuklaayush/zed-noir)
|
||||
- [Nu](https://github.com/zed-extensions/nu)
|
||||
- [Odin](https://github.com/rxptr/zed-odin)
|
||||
- [Odin](https://github.com/zed-extensions/odin)
|
||||
- [Pact](https://github.com/kadena-community/pact-zed)
|
||||
- [Pest](https://github.com/pest-parser/zed-pest)
|
||||
- [PICA200 assembly](https://github.com/Squareheron942/zed-pica200)
|
||||
@@ -147,7 +146,7 @@ Some work out-of-the-box and others rely on [3rd party extensions](./extensions/
|
||||
- [PlaydateSDK](https://github.com/notpeter/playdate-zed-extension)
|
||||
- [QML](https://github.com/lkroll/zed-qml)
|
||||
- [Rainbow CSV](https://github.com/weartist/zed-rainbow-csv)
|
||||
- [Rego](https://github.com/StyraInc/zed-rego)
|
||||
- [Rego](https://github.com/open-policy-agent/zed-rego)
|
||||
- [Rescript](https://github.com/humaans/rescript-zed)
|
||||
- [Roclang](https://github.com/h2000/zed-roc)
|
||||
- [Ron](https://github.com/onbjerg/zed-ron)
|
||||
|
||||
@@ -14,7 +14,7 @@ Zed has built-in support for CSS.
|
||||
|
||||
## Tailwind CSS
|
||||
|
||||
Zed also supports [Tailwind CSS](./tailwindcss.md) out-of-the-box. To use Tailwind CSS IntelliSense in CSS files, configure the Tailwind CSS language server for the `CSS` language and disable the default CSS language server. See the [docs page](./tailwindcss.md#L45) for Tailwind CSS for more detail.
|
||||
Zed also supports [Tailwind CSS](./tailwindcss.md) out-of-the-box. To use Tailwind CSS IntelliSense in CSS files, configure the Tailwind CSS language server for the `CSS` language and disable the default CSS language server. See the [docs page](./tailwindcss.md#using-tailwind-css-mode-in-css-files) for Tailwind CSS for more detail.
|
||||
|
||||
This enables autocomplete, diagnostics, and hover previews for Tailwind-specific CSS such as `@apply`, `@layer`, and `@theme`. The `tailwindcss-intellisense-css` language server is provided by Zed's built-in Tailwind CSS capabilities, and is an alternative to the default CSS language server; do not enable both at the same time.
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ The [documented wrap behaviors](https://docs.emmet.io/actions/wrap-with-abbrevia
|
||||
- Wrapping individual lines: mark the repeating element with `*` (without a number), for example `ul>li*`, and each selected line is wrapped in its own element. `$` numbering works too: `ul>li.item$*>a`.
|
||||
- Removing list markers: append the trim filter `|t`, for example `ul>li*|t`, to strip list markers such as `*`, `-`, or `1.` from the wrapped lines.
|
||||
- Controlling output position: use the `$#` placeholder inside attribute values or text nodes, for example `ul>li[title=$#]*>{$#}`.
|
||||
- The [comment filter](https://docs.emmet.io/filters/comment/) `|c` and the [BEM filter](https://docs.emmet.io/filters/bem/) `|bem` are also supported and can be combined, for example `div#page>p.intro|c|bem`.
|
||||
- The [comment filter](https://docs.emmet.io/filters/#comment-tags-c) `|c` and the [BEM filter](https://docs.emmet.io/filters/bem/) `|bem` are also supported and can be combined, for example `div#page>p.intro|c|bem`.
|
||||
|
||||
Selections that partially cover an opening or closing tag are expanded to the whole element before wrapping. Wrapping is a markup action: it is not offered in stylesheets, where Emmet provides completions instead.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ description: "Configure Gleam language support in Zed, including language server
|
||||
Gleam support is available through the [Gleam extension](https://github.com/gleam-lang/zed-gleam). To learn about Gleam, see the [docs](https://gleam.run/documentation/) or check out the [`stdlib` reference](https://hexdocs.pm/gleam_stdlib/). The Gleam language server has a variety of features, including go-to definition, automatic imports, and [more](https://gleam.run/language-server/).
|
||||
|
||||
- Tree-sitter: [gleam-lang/tree-sitter-gleam](https://github.com/gleam-lang/tree-sitter-gleam)
|
||||
- Language Server: [gleam lsp](https://github.com/gleam-lang/gleam/tree/main/compiler-core/src/language_server)
|
||||
- Language Server: [gleam lsp](https://github.com/gleam-lang/gleam/tree/main/language-server)
|
||||
|
||||
## Using the Tailwind CSS Language Server with Gleam
|
||||
|
||||
|
||||
@@ -34,7 +34,7 @@ Configure formatting in Settings ({#kb zed::OpenSettings}) under Languages > HTM
|
||||
}
|
||||
```
|
||||
|
||||
You can still trigger formatting manually with {#kb editor::Format} or by opening the [command palette](..//getting-started.md#command-palette) ({#kb command_palette::Toggle}) and selecting "Format Document".
|
||||
You can still trigger formatting manually with {#kb editor::Format} or by opening the [command palette](../command-palette.md) ({#kb command_palette::Toggle}) and selecting "Format Document".
|
||||
|
||||
### LSP Formatting
|
||||
|
||||
|
||||
@@ -5,14 +5,14 @@ description: "Configure Rego language support in Zed, including language servers
|
||||
|
||||
# Rego
|
||||
|
||||
Rego language support in Zed is provided by the community-maintained [Rego extension](https://github.com/StyraInc/zed-rego).
|
||||
Rego language support in Zed is provided by the community-maintained [Rego extension](https://github.com/open-policy-agent/zed-rego).
|
||||
|
||||
- Tree-sitter: [FallenAngel97/tree-sitter-rego](https://github.com/FallenAngel97/tree-sitter-rego)
|
||||
- Language Server: [open-policy-agent/regal](https://github.com/open-policy-agent/regal)
|
||||
|
||||
## Installation
|
||||
|
||||
The extension is largely based on the [Regal](https://docs.styra.com/regal/language-server) language server which should be installed to make use of the extension. Read the [getting started](https://docs.styra.com/regal#getting-started) instructions for more information.
|
||||
The extension uses the [Regal](https://www.openpolicyagent.org/projects/regal/language-server) language server. If `regal` is on your PATH, Zed uses it; otherwise the extension downloads it automatically. Read the [getting started](https://www.openpolicyagent.org/projects/regal#getting-started) instructions for more information.
|
||||
|
||||
## Configuration
|
||||
|
||||
@@ -40,4 +40,4 @@ rules:
|
||||
- "*_test.rego"
|
||||
```
|
||||
|
||||
Read Regal's [configuration documentation](https://docs.styra.com/regal#configuration) for more information.
|
||||
Read Regal's [configuration documentation](https://www.openpolicyagent.org/projects/regal/configuration) for more information.
|
||||
@@ -11,9 +11,9 @@ Roc language support in Zed is provided by the community-maintained [Roc extensi
|
||||
Report issues to: [https://github.com/h2000/zed-roc/issues](https://github.com/h2000/zed-roc/issues)
|
||||
|
||||
- Tree-sitter: [faldor20/tree-sitter-roc](https://github.com/faldor20/tree-sitter-roc)
|
||||
- Language Server: [roc-lang/roc/tree/main/crates/language_server](https://github.com/roc-lang/roc/tree/main/crates/language_server)
|
||||
- Language Server: [roc-lang/roc/tree/main/src/lsp](https://github.com/roc-lang/roc/tree/main/src/lsp)
|
||||
|
||||
## Setup
|
||||
|
||||
1. Follow instructions to [Install Roc](https://www.roc-lang.org/install) from the Roc-Lang website.
|
||||
2. Ensure `roc` and `roc_language_server` are in your PATH.
|
||||
2. Ensure `roc` is in your PATH.
|
||||
@@ -3427,7 +3427,7 @@ The following settings can be overridden for each specific language:
|
||||
- [`soft_wrap`](#soft-wrap)
|
||||
- [`soft_wrap_indent`](#soft-wrap-indent)
|
||||
- [`tab_size`](#tab-size)
|
||||
- [`use_autoclose`](#use-autoclose)
|
||||
- [`use_autoclose`](#auto-close)
|
||||
- [`always_treat_brackets_as_autoclosed`](#always-treat-brackets-as-autoclosed)
|
||||
|
||||
These values take in the same options as the root-level settings with the same name.
|
||||
@@ -3563,6 +3563,16 @@ Positive `integer` values or `null` for unlimited tabs
|
||||
|
||||
`boolean` values
|
||||
|
||||
## Modeline Lines
|
||||
|
||||
- Description: Number of lines to search for [modelines](../modelines.md) at the beginning and end of files
|
||||
- Setting: `modeline_lines`
|
||||
- Default: `5`
|
||||
|
||||
**Options**
|
||||
|
||||
Positive `integer` values, or `0` to disable modeline parsing
|
||||
|
||||
## Multi Cursor Modifier
|
||||
|
||||
- Description: Determines the modifier to be used to add multiple cursors with the mouse. The open hover link mouse gestures will adapt such that it does not conflict with the multicursor modifier.
|
||||
|
||||
+2
-8
@@ -11,18 +11,10 @@ Zed's built-in REPL uses [Jupyter kernels](https://docs.jupyter.org/en/latest/pr
|
||||
|
||||
<figure style="width: 100%; margin: 0; overflow: hidden; border-top-left-radius: 2px; border-top-right-radius: 2px;">
|
||||
<video loop controls playsinline>
|
||||
<source
|
||||
src="https://customer-snccc0j9v3kfzkif.cloudflarestream.com/aec66e79f23d6d1a0bee5e388a3f17cc/downloads/default.mp4"
|
||||
type='video/webm; codecs="vp8.0, vorbis"'
|
||||
/>
|
||||
<source
|
||||
src="https://customer-snccc0j9v3kfzkif.cloudflarestream.com/aec66e79f23d6d1a0bee5e388a3f17cc/downloads/default.mp4"
|
||||
type='video/mp4; codecs="avc1.4D401E, mp4a.40.2"'
|
||||
/>
|
||||
<source
|
||||
src="https://zed.dev/img/post/repl/typescript-deno-kernel-markdown.png"
|
||||
type="image/png"
|
||||
/>
|
||||
</video>
|
||||
</figure>
|
||||
|
||||
@@ -41,6 +33,8 @@ Zed supports running code in multiple languages. To get started, you need to ins
|
||||
|
||||
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 {#action repl::RefreshKernelspecs} command to make them available in the editor.
|
||||
|
||||
|
||||
|
||||
## Using the REPL
|
||||
|
||||
To start the REPL, open a file with the language you want to use and use the {#action repl::Run} command (defaults to `ctrl-shift-enter` on macOS) to run a block, selection, or line. You can also click on the REPL icon in the toolbar.
|
||||
|
||||
+1
-2
@@ -165,8 +165,7 @@ Zed's vim mode includes features commonly provided by plugins in the Vim ecosyst
|
||||
- You can use `gR` to do [ReplaceWithRegister](https://github.com/vim-scripts/ReplaceWithRegister).
|
||||
- You can use `cx` for [vim-exchange](https://github.com/tommcdo/vim-exchange) functionality. Note that it does not have a default binding in visual mode, but you can add one to your keymap (refer to the [optional key bindings](#optional-key-bindings) section).
|
||||
- You can navigate to indent depths relative to your cursor with the [indent wise](https://github.com/jeetsukumaran/vim-indentwise) plugin `[-`, `]-`, `[+`, `]+`, `[=`, `]=`.
|
||||
- You can select quoted text with AnyQuotes and bracketed text with AnyBrackets text objects. Zed also provides MiniQuotes and MiniBrackets which offer alternative selection behavior based on the [mini.ai](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-ai.md) Neovim plugin. See the [Quote and Bracket text objects](#quote-and-bracket-text-objects) section below for details.
|
||||
- You can configure AnyQuotes, AnyBrackets, MiniQuotes, and MiniBrackets text objects for selecting quoted and bracketed text using different selection strategies. See the [Any Bracket Functionality](#any-bracket-functionality) section below for details.
|
||||
- You can select quoted text with AnyQuotes and bracketed text with AnyBrackets text objects. Zed also provides MiniQuotes and MiniBrackets, which offer alternative selection behavior based on the [mini.ai](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-ai.md) Neovim plugin. These text objects are not bound by default; see the [Any Bracket Functionality](#any-bracket-functionality) section below for how to configure them.
|
||||
|
||||
### Any Bracket Functionality
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ If you are looking for the Zed extension registry, see the [`zed-industries/exte
|
||||
|
||||
## Structure
|
||||
|
||||
Currently, Zed includes support for a number of languages without requiring installing an extension. Those languages can be found under [`crates/languages/src`](https://github.com/zed-industries/zed/tree/main/crates/languages/src).
|
||||
Currently, Zed includes support for a number of languages without requiring installing an extension. Their grammars, queries, and configs can be found under [`crates/grammars/src`](https://github.com/zed-industries/zed/tree/main/crates/grammars/src), and their language server adapters under [`crates/languages/src`](https://github.com/zed-industries/zed/tree/main/crates/languages/src).
|
||||
|
||||
Support for all other languages is done via extensions. This directory ([extensions/](https://github.com/zed-industries/zed/tree/main/extensions/)) contains some of the officially maintained extensions. These extensions use the same [zed_extension_api](https://docs.rs/zed_extension_api/latest/zed_extension_api/) available to all [Zed Extensions](https://zed.dev/extensions) for providing [language servers](https://zed.dev/docs/extensions/languages#language-servers), [tree-sitter grammars](https://zed.dev/docs/extensions/languages#grammar) and [tree-sitter queries](https://zed.dev/docs/extensions/languages#tree-sitter-queries).
|
||||
|
||||
|
||||
Reference in new issue
Block a user