From 3220986fc94fde0051e615150dcabe76738d1310 Mon Sep 17 00:00:00 2001 From: Marshall Bowers Date: Wed, 21 Feb 2024 13:21:22 -0500 Subject: [PATCH] Format docs with Prettier (#8134) This PR formats the docs with Prettier. Release Notes: - N/A --- docs/how-to-deploy.md | 4 ++-- docs/src/configuring_zed.md | 1 + docs/src/configuring_zed__key_bindings.md | 16 ++++++++-------- docs/src/developing_zed__building_zed_linux.md | 1 - docs/src/languages/go.md | 4 +++- docs/src/languages/ocaml.md | 7 +++++-- docs/src/languages/svelte.md | 1 + docs/src/languages/typescript.md | 2 ++ 8 files changed, 22 insertions(+), 14 deletions(-) diff --git a/docs/how-to-deploy.md b/docs/how-to-deploy.md index c32d3619a6..b1561c701f 100644 --- a/docs/how-to-deploy.md +++ b/docs/how-to-deploy.md @@ -2,9 +2,9 @@ These docs are intendended to replace both docs.zed.dev and introduce people to 1. `cd docs` from repo root 1. Install the vercel cli if you haven't already - - `pnpm i -g vercel` + - `pnpm i -g vercel` 1. `vercel` to deploy if you already have the project linked 1. Otherwise, `vercel login` and `vercel` to link - - Choose Zed Industries as the team, then `zed-app-docs` as the project + - Choose Zed Industries as the team, then `zed-app-docs` as the project Someone can write a script for this when they have time. diff --git a/docs/src/configuring_zed.md b/docs/src/configuring_zed.md index e129721dd5..f6b5b43122 100644 --- a/docs/src/configuring_zed.md +++ b/docs/src/configuring_zed.md @@ -307,6 +307,7 @@ To override settings for a language, add an entry for that language server's nam ``` ## Auto close + - Description: Whether or not to automatically type closing characters for you. - Setting: `use_autoclose` - Default: `true` diff --git a/docs/src/configuring_zed__key_bindings.md b/docs/src/configuring_zed__key_bindings.md index 60f84965c1..186534432c 100644 --- a/docs/src/configuring_zed__key_bindings.md +++ b/docs/src/configuring_zed__key_bindings.md @@ -8,7 +8,6 @@ A selection of base keymaps is available in the welcome screen under the "Choose Additionally, you can change the base keymap from the command palette - `⌘-Shift-P` - by selecting the "welcome: toggle base keymap selector" command. - ## Custom key bindings ### Accessing custom key bindings @@ -39,24 +38,25 @@ 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._ ## Special Keyboard Layouts + Some people have unique and custom keyboard layouts. For example, [@TomPlanche](https://github.com/TomPlanche) having a [French keyboard](https%3A%2F%2Fcdn.shopify.com%2Fs%2Ffiles%2F1%2F0810%2F3669%2Ffiles%2Ffrench-azerty-mac-keyboard-layout-2021-keyshorts.png&f=1&nofb=1&ipt=f53a06c5e60a20b621082410aa699c8cceff269a11ff90b3b5a35c6124dbf827&ipo=images), had to type `Shift-Alt-(` in order to have a simple `[` so he made a simple layout with those 'rules': `ù -> [`, `backtick -> ]`, `Alt-[ (where [ is the old ù) -> {`, `Alt-] -> }`. But, it was impossible to take into account the `{` and `}` when he was typing so now, in order to ignore a binding, he can add `null` to the binding: + ```json [ - { - "context": "Editor", - "bindings": { - "alt-[": null, - "alt-]": null - } + { + "context": "Editor", + "bindings": { + "alt-[": null, + "alt-]": null } + } ] ``` - ## All key bindings ### Global diff --git a/docs/src/developing_zed__building_zed_linux.md b/docs/src/developing_zed__building_zed_linux.md index 18dc683ac2..e1046d7841 100644 --- a/docs/src/developing_zed__building_zed_linux.md +++ b/docs/src/developing_zed__building_zed_linux.md @@ -26,7 +26,6 @@ git submodule update --init --recursive - If you prefer to install the system libraries manually, you can find the list of required packages in the `script/linux` file. - ## Backend Dependencies # Note: This section is still in development. The instructions are not yet complete. diff --git a/docs/src/languages/go.md b/docs/src/languages/go.md index 79ab5610fb..9dbb322897 100644 --- a/docs/src/languages/go.md +++ b/docs/src/languages/go.md @@ -22,6 +22,7 @@ Zed sets the following initialization options for inlay hints: to make the language server send back inlay hints when Zed has them enabled in the settings. Use + ```json "lsp": { "$LANGUAGE_SERVER_NAME": { @@ -33,6 +34,7 @@ Use } } ``` + to override these settings. See https://github.com/golang/tools/blob/master/gopls/doc/inlayHints.md for more information. @@ -49,5 +51,5 @@ TODO: https://github.com/zed-industries/zed/pull/7139 # Go Work - Tree Sitter: -[tree-sitter-go-work](https://github.com/d1y/tree-sitter-go-work) + [tree-sitter-go-work](https://github.com/d1y/tree-sitter-go-work) - Language Server: N/A diff --git a/docs/src/languages/ocaml.md b/docs/src/languages/ocaml.md index 5424803e74..c80ec98963 100644 --- a/docs/src/languages/ocaml.md +++ b/docs/src/languages/ocaml.md @@ -4,14 +4,17 @@ - Language Server: [ocamllsp](https://github.com/ocaml/ocaml-lsp) ## Setup Instructions + If you have the development environment already setup, you can skip to [Launching Zed](#launching-zed) ### Using OPAM -Opam is the official package manager for OCaml and is highly recommended for getting started with OCaml. To get started using Opam, please follow the instructions provided [here](https://ocaml.org/install). + +Opam is the official package manager for OCaml and is highly recommended for getting started with OCaml. To get started using Opam, please follow the instructions provided [here](https://ocaml.org/install). Once you install opam and setup a switch with your development environment as per the instructions, you can proceed. ### Launching Zed + By now you should have `ocamllsp` installed, you can verify so by running ```sh @@ -22,7 +25,7 @@ in your terminal. If you get a help message, you're good to go. If not, please r With that aside, we can now launch Zed. Given how the OCaml package manager works, we require you to run Zed from the terminal, so please make sure you install the [Zed cli](https://zed.dev/features#cli) if you haven't already. -Once you have the cli, simply from a terminal, navigate to your project and run +Once you have the cli, simply from a terminal, navigate to your project and run ```sh $ zed . diff --git a/docs/src/languages/svelte.md b/docs/src/languages/svelte.md index d8474b539a..e6b1281893 100644 --- a/docs/src/languages/svelte.md +++ b/docs/src/languages/svelte.md @@ -51,6 +51,7 @@ Use } } } +``` to override these settings. diff --git a/docs/src/languages/typescript.md b/docs/src/languages/typescript.md index 4bfd15dc16..7210e169e9 100644 --- a/docs/src/languages/typescript.md +++ b/docs/src/languages/typescript.md @@ -23,6 +23,7 @@ Zed sets the following initialization options for inlay hints: to make the language server send back inlay hints when Zed has them enabled in the settings. Use + ```json "lsp": { "$LANGUAGE_SERVER_NAME": { @@ -34,6 +35,7 @@ Use } } ``` + to override these settings. See https://github.com/typescript-language-server/typescript-language-server?tab=readme-ov-file#inlay-hints-textdocumentinlayhint for more information.