Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Adjust heading levels in docs (#7163)

Browse source 
This PR adjusts the heading levels in the docs, as some of them weren't
following the right hierarchy.

I also formatted all of the docs with Prettier.

Release Notes:

- N/A
This commit is contained in:
Marshall Bowers 2024-01-31 12:34:31 -05:00 • committed by GitHub
parent 6e443ac298
commit 39200ec9f7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
14 changed files with 144 additions and 137 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/src/CODE_OF_CONDUCT.md
View file

@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our Examples of behavior that contributes to a positive environment for our
community include: community include:
* Demonstrating empathy and kindness toward other people - Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences - Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback - Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes, - Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience and learning from the experience
* Focusing on what is best not just for us as individuals, but for the - Focusing on what is best not just for us as individuals, but for the
overall community overall community
Examples of unacceptable behavior include: Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or - The use of sexualized language or imagery, and sexual attention or
advances of any kind advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks - Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment - Public or private harassment
* Publishing others' private information, such as a physical or email - Publishing others' private information, such as a physical or email
address, without their explicit permission address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a - Other conduct which could reasonably be considered inappropriate in a
professional setting professional setting
## Enforcement Responsibilities ## Enforcement Responsibilities

3
docs/src/configuring_zed.md
View file

@ -20,7 +20,7 @@ The following global settings can be overridden with a folder-specific configura
- `show_copilot_suggestions` - `show_copilot_suggestions`
- `show_whitespaces` - `show_whitespaces`
*See the Global settings section for details about these settings* _See the Global settings section for details about these settings_
## Global settings ## Global settings
@ -1005,6 +1005,7 @@ Run the `theme selector: toggle` action in the command palette to see a current
``` ```
### Default Width ### Default Width
- Description: Customise default width taken by project panel - Description: Customise default width taken by project panel
- Setting: `default_width` - Setting: `default_width`
- Default: N/A width in pixels (eg: 420) - Default: N/A width in pixels (eg: 420)

31
docs/src/configuring_zed__configuring_vim.md
View file

@ -2,15 +2,18 @@
Zed includes a vim emulation layer known as “vim mode”. This document aims to describe how it works, and how to make the most out of it. Zed includes a vim emulation layer known as “vim mode”. This document aims to describe how it works, and how to make the most out of it.
### Philosophy ## Philosophy
Vim mode in Zed is supposed to primarily "do what you expect": it mostly tries to copy vim exactly, but will use Zed-specific functionality when available to make things smoother. Vim mode in Zed is supposed to primarily "do what you expect": it mostly tries to copy vim exactly, but will use Zed-specific functionality when available to make things smoother.
This means Zed will never be 100% vim compatible, but should be 100% vim familiar! We expect that our vim mode already copes with 90% of your workflow, and we'd like to keep improving it. If you find things that you can’t yet do in vim mode, but which you rely on in your current workflow, please leave feedback in the editor itself (`:feedback`), or [file an issue](https://github.com/zed-industries/zed/issues). This means Zed will never be 100% vim compatible, but should be 100% vim familiar! We expect that our vim mode already copes with 90% of your workflow, and we'd like to keep improving it. If you find things that you can’t yet do in vim mode, but which you rely on in your current workflow, please leave feedback in the editor itself (`:feedback`), or [file an issue](https://github.com/zed-industries/zed/issues).
### Zed-specific features ## Zed-specific features
Zed is built on a modern foundation that (among other things) uses tree-sitter to understand the content of the file you're editing, and supports multiple cursors out of the box. Zed is built on a modern foundation that (among other things) uses tree-sitter to understand the content of the file you're editing, and supports multiple cursors out of the box.
Vim mode has several "core Zed" key bindings, that will help you make the most of Zed's specific feature set. Vim mode has several "core Zed" key bindings, that will help you make the most of Zed's specific feature set.
``` ```
# Normal mode # Normal mode
g d Go to definition g d Go to definition
@ -45,7 +48,8 @@ Vim mode emulates visual block mode using Zed's multiple cursor support. This ag
Finally, Vim mode's search and replace functionality is backed by Zed's. This means that the pattern syntax is slightly different, see the section on [Regex differences](#regex-differences) for details. Finally, Vim mode's search and replace functionality is backed by Zed's. This means that the pattern syntax is slightly different, see the section on [Regex differences](#regex-differences) for details.
### Custom key bindings ## Custom key bindings
Zed does not yet have an equivalent to vim’s `map` command to convert one set of keystrokes into another, however you can bind any sequence of keys to fire any Action documented in the [Key bindings documentation](https://docs.zed.dev/configuration/key-bindings). Zed does not yet have an equivalent to vim’s `map` command to convert one set of keystrokes into another, however you can bind any sequence of keys to fire any Action documented in the [Key bindings documentation](https://docs.zed.dev/configuration/key-bindings).
You can edit your personal key bindings with `:keymap`. You can edit your personal key bindings with `:keymap`.
@ -84,7 +88,7 @@ You can see the bindings that are enabled by default in vim mode [here](https://
The details of the context are a little out of scope for this doc, but suffice to say that `menu` is true when a menu is open (e.g. the completions menu), `VimWaiting` is true after you type `f` or `t` when we’re waiting for a new key (and you probably don’t want bindings to happen). Please reach out on [GitHub](https://github.com/zed-industries/zed) if you want help making a key bindings work. The details of the context are a little out of scope for this doc, but suffice to say that `menu` is true when a menu is open (e.g. the completions menu), `VimWaiting` is true after you type `f` or `t` when we’re waiting for a new key (and you probably don’t want bindings to happen). Please reach out on [GitHub](https://github.com/zed-industries/zed) if you want help making a key bindings work.
### Command palette ## Command palette
Vim mode allows you to enable Zed’s command palette with `:`. This means that you can use vim's command palette to run any action that Zed supports. Vim mode allows you to enable Zed’s command palette with `:`. This means that you can use vim's command palette to run any action that Zed supports.
@ -95,6 +99,7 @@ We do not (yet) emulate the full power of vim’s command line, in particular we
As mentioned above, one thing to be aware of is that the regex engine is slightly different from vim's in `:%s/a/b`. As mentioned above, one thing to be aware of is that the regex engine is slightly different from vim's in `:%s/a/b`.
Currently supported vim-specific commands (as of Zed 0.106): Currently supported vim-specific commands (as of Zed 0.106):
``` ```
# window management # window management
:w[rite][!], :wq[!], :q[uit][!], :wa[ll][!], :wqa[ll][!], :qa[ll][!], :[e]x[it][!], :up[date] :w[rite][!], :wq[!], :q[uit][!], :wa[ll][!], :wqa[ll][!], :qa[ll][!], :[e]x[it][!], :up[date]
@ -139,9 +144,10 @@ Currently supported vim-specific commands (as of Zed 0.106):
to sort the current selection (with i, case-insensitively) to sort the current selection (with i, case-insensitively)
``` ```
## Related settings
### Related settings
There are a few Zed settings that you may also enjoy if you use vim mode: There are a few Zed settings that you may also enjoy if you use vim mode:
```json ```json
{ {
// disable cursor blink // disable cursor blink
@ -153,17 +159,18 @@ There are a few Zed settings that you may also enjoy if you use vim mode:
} }
``` ```
### Regex differences ## Regex differences
Zed uses a different regular expression engine from Vim. This means that you will have to use a different syntax for some things. Zed uses a different regular expression engine from Vim. This means that you will have to use a different syntax for some things.
Notably: Notably:
* Vim uses `\(` and `\)` to represent capture groups, in Zed these are `(` and `)`.
* On the flip side, `(` and `)` represent literal parentheses, but in Zed these must be escaped to `\(` and `\)`. - Vim uses `\(` and `\)` to represent capture groups, in Zed these are `(` and `)`.
* When replacing, Vim uses `\0` to represent the entire match, in Zed this is `$0`, same for numbered capture groups `\1` -> `$1`. - On the flip side, `(` and `)` represent literal parentheses, but in Zed these must be escaped to `\(` and `\)`.
* Vim uses `\<` and `\>` to represent word boundaries, in Zed these are both handled by `\b` - When replacing, Vim uses `\0` to represent the entire match, in Zed this is `$0`, same for numbered capture groups `\1` -> `$1`.
* Vim uses `/g` to indicate "all matches on one line", in Zed this is implied - Vim uses `\<` and `\>` to represent word boundaries, in Zed these are both handled by `\b`
* Vim uses `/i` to indicate "case-insensitive", in Zed you can either use `(?i)` at the start of the pattern or toggle case-sensitivity with `cmd-option-c`. - Vim uses `/g` to indicate "all matches on one line", in Zed this is implied
- Vim uses `/i` to indicate "case-insensitive", in Zed you can either use `(?i)` at the start of the pattern or toggle case-sensitivity with `cmd-option-c`.
To help with the transition, the command palette will fix parentheses and replace groups for you when you run `:%s//`. So `%s:/\(a\)(b)/\1/` will be converted into a search for "(a)\(b\)" and a replacement of "$1". To help with the transition, the command palette will fix parentheses and replace groups for you when you run `:%s//`. So `%s:/\(a\)(b)/\1/` will be converted into a search for "(a)\(b\)" and a replacement of "$1".

32
docs/src/configuring_zed__key_bindings.md
View file

@ -1,16 +1,16 @@
Zed can be configured via a simple JSON file located at `~/.config/zed/keymap.json`. Zed can be configured via a simple JSON file located at `~/.config/zed/keymap.json`.
### Predefined keymaps ## Predefined keymaps
We have a growing collection of pre-defined keymaps in [zed repository's keymaps folder](https://github.com/zed-industries/zed/tree/main/assets/keymaps). We have a growing collection of pre-defined keymaps in [zed repository's keymaps folder](https://github.com/zed-industries/zed/tree/main/assets/keymaps).
### Custom key bindings ## Custom key bindings
#### Accessing custom key bindings ### Accessing custom key bindings
You can open `keymap.json` via `⌘` + `K`, `⌘` + `S`, the command palette, or the `Zed > Settings > Open Key Bindings` application menu item. You can open `keymap.json` via `⌘` + `K`, `⌘` + `S`, the command palette, or the `Zed > Settings > Open Key Bindings` application menu item.
#### Adding a custom key binding ### Adding a custom key binding
To customize key bindings, specify a context and the list of bindings to set. Re-mapping an existing binding will clobber the existing binding in favor of the custom one. To customize key bindings, specify a context and the list of bindings to set. Re-mapping an existing binding will clobber the existing binding in favor of the custom one.
@ -33,9 +33,9 @@ You can see more examples in Zed's [`default.json`](https://zed.dev/ref/default.
_There are some key bindings that can't be overridden; we are working on an issue surrounding this._ _There are some key bindings that can't be overridden; we are working on an issue surrounding this._
### All key bindings ## All key bindings
#### Global ### Global
| **Command** | **Target** | **Default Shortcut** | | **Command** | **Target** | **Default Shortcut** |
| -------------------------------- | -------------- | ----------------------------- | | -------------------------------- | -------------- | ----------------------------- |
@ -97,7 +97,7 @@ _There are some key bindings that can't be overridden; we are working on an issu
| Reset buffer font size | Zed | `⌘` + `0` | | Reset buffer font size | Zed | `⌘` + `0` |
| Toggle full screen | Zed | `Control` + `⌘` + `F` | | Toggle full screen | Zed | `Control` + `⌘` + `F` |
#### Editor ### Editor
| **Command** | **Target** | **Default Shortcut** | | **Command** | **Target** | **Default Shortcut** |
| -------------------------------- | ---------- | ------------------------------------- | | -------------------------------- | ---------- | ------------------------------------- |
@ -240,7 +240,7 @@ _There are some key bindings that can't be overridden; we are working on an issu
| Undo selection | Editor | `⌘` + `U` | | Undo selection | Editor | `⌘` + `U` |
| Unfold lines | Editor | `Alt` + `⌘` + `]` | | Unfold lines | Editor | `Alt` + `⌘` + `]` |
#### Editor (Full Only) ### Editor (Full Only)
| **Command** | **Target** | **Default Shortcut** | | **Command** | **Target** | **Default Shortcut** |
| ------------------- | ------------- | ----------------------- | | ------------------- | ------------- | ----------------------- |
@ -258,14 +258,14 @@ _There are some key bindings that can't be overridden; we are working on an issu
| Toggle | Go To Line | `Control` + `G` | | Toggle | Go To Line | `Control` + `G` |
| Toggle | Outline | `⌘` + `Shift` + `O` | | Toggle | Outline | `⌘` + `Shift` + `O` |
#### Editor (Auto Height Only) ### Editor (Auto Height Only)
| **Command** | **Target** | **Default Shortcut** | | **Command** | **Target** | **Default Shortcut** |
| ------------- | ---------- | ----------------------------- | | ------------- | ---------- | ----------------------------- |
| Newline | Editor | `Control` + `Enter` | | Newline | Editor | `Control` + `Enter` |
| Newline below | Editor | `Control` + `Shift` + `Enter` | | Newline below | Editor | `Control` + `Shift` + `Enter` |
#### Pane ### Pane
| **Command** | **Target** | **Default Shortcut** | | **Command** | **Target** | **Default Shortcut** |
| ---------------------- | -------------- | -------------------- | | ---------------------- | -------------- | -------------------- |
@ -300,7 +300,7 @@ _There are some key bindings that can't be overridden; we are working on an issu
| Toggle replace | Search | `⌘` + `Shift` + `H` | | Toggle replace | Search | `⌘` + `Shift` + `H` |
| Toggle whole word | Search | `Alt` + `⌘` + `W` | | Toggle whole word | Search | `Alt` + `⌘` + `W` |
#### Buffer Search Bar ### Buffer Search Bar
| **Command** | **Target** | **Default Shortcut** | | **Command** | **Target** | **Default Shortcut** |
| ---------------------- | ------------- | -------------------- | | ---------------------- | ------------- | -------------------- |
@ -315,7 +315,7 @@ _There are some key bindings that can't be overridden; we are working on an issu
| Select next match | Search | `Enter` | | Select next match | Search | `Enter` |
| Select prev match | Search | `Shift` + `Enter` | | Select prev match | Search | `Shift` + `Enter` |
#### Workspace ### Workspace
| **Command** | **Target** | **Default Shortcut** | | **Command** | **Target** | **Default Shortcut** |
| ------------------ | ----------------- | -------------------- | | ------------------ | ----------------- | -------------------- |
@ -344,7 +344,7 @@ _There are some key bindings that can't be overridden; we are working on an issu
| Toggle right dock | Workspace | `⌘` + `R` | | Toggle right dock | Workspace | `⌘` + `R` |
| Open keymap | Zed | `⌘` + `K`, `⌘` + `S` | | Open keymap | Zed | `⌘` + `K`, `⌘` + `S` |
#### Project Panel ### Project Panel
| **Command** | **Target** | **Default Shortcut** | | **Command** | **Target** | **Default Shortcut** |
| ----------------------- | ------------- | --------------------------- | | ----------------------- | ------------- | --------------------------- |
@ -364,7 +364,7 @@ _There are some key bindings that can't be overridden; we are working on an issu
| Rename | Project Panel | `F2` | | Rename | Project Panel | `F2` |
| Reveal in finder | Project Panel | `Alt` + `⌘` + `R` | | Reveal in finder | Project Panel | `Alt` + `⌘` + `R` |
#### Project Search Bar ### Project Search Bar
| **Command** | **Target** | **Default Shortcut** | | **Command** | **Target** | **Default Shortcut** |
| ---------------------- | -------------- | -------------------- | | ---------------------- | -------------- | -------------------- |
@ -380,7 +380,7 @@ _There are some key bindings that can't be overridden; we are working on an issu
| Replace next | Search | `Enter` | | Replace next | Search | `Enter` |
| Toggle replace | Search | `⌘` + `Shift` + `H` | | Toggle replace | Search | `⌘` + `Shift` + `H` |
#### Terminal ### Terminal
| **Command** | **Target** | **Default Shortcut** | | **Command** | **Target** | **Default Shortcut** |
| --------------------------- | ---------- | ------------------------- | | --------------------------- | ---------- | ------------------------- |
@ -394,7 +394,7 @@ _There are some key bindings that can't be overridden; we are working on an issu
| Paste | Terminal | `⌘` + `V` | | Paste | Terminal | `⌘` + `V` |
| Show character palette | Terminal | `Control` + `⌘` + `Space` | | Show character palette | Terminal | `Control` + `⌘` + `Space` |
#### Assistant Editor ### Assistant Editor
| **Command** | **Target** | **Default Shortcut** | | **Command** | **Target** | **Default Shortcut** |
| ------------------ | ---------- | -------------------- | | ------------------ | ---------- | -------------------- |

2
docs/src/developing_zed__adding_languages.md
View file

@ -21,7 +21,7 @@ const font: FontFamily = {
weight: "normal", weight: "normal",
underline: false, underline: false,
italic: false, italic: false,
} };
``` ```
Match a property identifier and highlight it using the identifier `@property`. In the above example, `weight`, `underline`, and `italic` would be highlighted. Match a property identifier and highlight it using the identifier `@property`. In the above example, `weight`, `underline`, and `italic` would be highlighted.

2
docs/src/developing_zed__local_collaboration.md
View file

@ -12,7 +12,7 @@ script/bootstrap
This script will set up the `zed` Postgres database, and populate it with some users. It requires internet access, because it fetches some users from the GitHub API. This script will set up the `zed` Postgres database, and populate it with some users. It requires internet access, because it fetches some users from the GitHub API.
The script will create several *admin* users, who you'll sign in as by default when developing locally. The GitHub logins for these default admin users are specified in this file: The script will create several _admin_ users, who you'll sign in as by default when developing locally. The GitHub logins for these default admin users are specified in this file:
``` ```
cat crates/collab/.admins.default.json cat crates/collab/.admins.default.json

12
docs/src/feedback.md
View file

@ -1,29 +1,29 @@
# Giving feedback # Giving feedback
### Zed repository ## Zed repository
We track our issues at [`zed-industries/zed`](https://github.com/zed-industries/zed/issues). We track our issues at [`zed-industries/zed`](https://github.com/zed-industries/zed/issues).
#### Feature requests ### Feature requests
Try to focus on the things that are most critical to you rather than exhaustively listing all features another editor you have used has. Try to focus on the things that are most critical to you rather than exhaustively listing all features another editor you have used has.
Command palette: `request feature` Command palette: `request feature`
#### Bug reports ### Bug reports
Try to add as much detail as possible, if it is not obvious to reproduce. Let us know how severe the problem is for you; is the issue more of a minor inconvenience or something that would prevent you from using Zed? Try to add as much detail as possible, if it is not obvious to reproduce. Let us know how severe the problem is for you; is the issue more of a minor inconvenience or something that would prevent you from using Zed?
Command palette: `file bug report` Command palette: `file bug report`
### In-app feedback ## In-app feedback
Anonymous feedback can be submitted from within Zed via the feedback editor (command palette: `give feedback`). Anonymous feedback can be submitted from within Zed via the feedback editor (command palette: `give feedback`).
### Zed forum ## Zed forum
Use the [Zed forum](https://github.com/zed-industries/zed/discussions) to ask questions and learn from one another. We will be present in the forum and answering questions as well. Use the [Zed forum](https://github.com/zed-industries/zed/discussions) to ask questions and learn from one another. We will be present in the forum and answering questions as well.
### Email ## Email
If you prefer to write up your thoughts as an email, you can send them to [hi@zed.dev](mailto:hi@zed.dev). If you prefer to write up your thoughts as an email, you can send them to [hi@zed.dev](mailto:hi@zed.dev).

6
docs/src/getting_started.md
View file

@ -2,14 +2,14 @@
Welcome to Zed! We are excited to have you. Here is a jumping-off point to getting started. Welcome to Zed! We are excited to have you. Here is a jumping-off point to getting started.
### Download Zed ## Download Zed
You can obtain the release build via the [download page](https://zed.dev/download). After the first manual installation, Zed will periodically check for and install updates automatically for you. You can obtain the release build via the [download page](https://zed.dev/download). After the first manual installation, Zed will periodically check for and install updates automatically for you.
### Configure Zed ## Configure Zed
Use `⌘` + `,` to open your custom settings to set things like fonts, formatting settings, per-language settings and more. You can access the default configuration using the `Zed > Settings > Open Default Settings` menu item. See Configuring Zed for all available settings. Use `⌘` + `,` to open your custom settings to set things like fonts, formatting settings, per-language settings and more. You can access the default configuration using the `Zed > Settings > Open Default Settings` menu item. See Configuring Zed for all available settings.
### Set up your key bindings ## Set up your key bindings
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 own key bindings. See Key Bindings for more info. 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 own key bindings. See Key Bindings for more info.

6
docs/src/languages/python.md
View file

@ -17,8 +17,8 @@ By default, the Pyright language server will look for Python packages in the def
To do this, create a JSON file called `pyrightconfig.json` at the root of your project. This file must include two keys: To do this, create a JSON file called `pyrightconfig.json` at the root of your project. This file must include two keys:
* `venvPath`: a relative path from your project directory to any directory that _contains_ one or more virtual environment directories - `venvPath`: a relative path from your project directory to any directory that _contains_ one or more virtual environment directories
* `venv`: the name of a virtual environment directory - `venv`: the name of a virtual environment directory
For example, a common approach is to create a virtual environment directory called `.venv` at the root of your project directory with the following commands: For example, a common approach is to create a virtual environment directory called `.venv` at the root of your project directory with the following commands:
@ -40,7 +40,7 @@ Having done that, you would create a `pyrightconfig.json` with the following con
### Code formatting ### Code formatting
The Pyright language server does not provide code formatting. If you want to automatically reformat your Python code when saving, you'll need to specify an _external_code formatter in your settings. See the [configuration](../configuration/configuring-zed.md) documentation for more information. The Pyright language server does not provide code formatting. If you want to automatically reformat your Python code when saving, you'll need to specify an \_external_code formatter in your settings. See the [configuration](../configuration/configuring-zed.md) documentation for more information.
A common tool for formatting python code is [Black](https://black.readthedocs.io/en/stable/). If you have Black installed globally, you can use it to format Python files by adding the following to your `settings.json`: A common tool for formatting python code is [Black](https://black.readthedocs.io/en/stable/). If you have Black installed globally, you can use it to format Python files by adding the following to your `settings.json`:

1
docs/src/languages/toml.md
View file

@ -1,5 +1,4 @@
# TOML # TOML
- Tree Sitter: [tree-sitter-toml](https://github.com/tree-sitter/tree-sitter-toml) - Tree Sitter: [tree-sitter-toml](https://github.com/tree-sitter/tree-sitter-toml)
- Language Server: [taplo](https://taplo.tamasfe.dev) - Language Server: [taplo](https://taplo.tamasfe.dev)