From 3a5d116ffebea61e174a185a3b914f6af615d14c Mon Sep 17 00:00:00 2001 From: Marshall Bowers Date: Thu, 4 Jul 2024 11:08:38 -0400 Subject: [PATCH] docs: Update language docs and include links in the sidebar (#13828) This PR updates the supported language docs and adds them to the sidebar for better discoverability. Release Notes: - N/A --- docs/src/SUMMARY.md | 30 ++++++++++++++++++++++++++++++ docs/src/languages/astro.md | 3 +-- docs/src/languages/c.md | 2 ++ docs/src/languages/clojure.md | 3 +-- docs/src/languages/cpp.md | 2 ++ docs/src/languages/csharp.md | 3 +-- docs/src/languages/css.md | 2 ++ docs/src/languages/deno.md | 3 +-- docs/src/languages/elm.md | 6 ++---- docs/src/languages/erb.md | 4 ---- docs/src/languages/erlang.md | 3 +-- docs/src/languages/gleam.md | 3 +-- docs/src/languages/haskell.md | 3 +-- docs/src/languages/html.md | 15 +++++++++++++-- docs/src/languages/json.md | 2 ++ docs/src/languages/lua.md | 3 +-- docs/src/languages/markdown.md | 2 ++ docs/src/languages/ocaml.md | 5 ++--- docs/src/languages/php.md | 3 +-- docs/src/languages/prisma.md | 3 +-- docs/src/languages/proto.md | 2 ++ docs/src/languages/purescript.md | 3 +-- docs/src/languages/racket.md | 3 +-- docs/src/languages/ruby.md | 2 ++ docs/src/languages/scheme.md | 3 +-- docs/src/languages/svelte.md | 3 +-- docs/src/languages/terraform.md | 3 +-- docs/src/languages/toml.md | 3 +-- docs/src/languages/tsx.md | 4 ---- docs/src/languages/typescript.md | 2 ++ docs/src/languages/uiua.md | 3 +-- docs/src/languages/vue.md | 5 ++--- docs/src/languages/yaml.md | 2 ++ docs/src/languages/zig.md | 3 +-- 34 files changed, 85 insertions(+), 56 deletions(-) delete mode 100644 docs/src/languages/erb.md delete mode 100644 docs/src/languages/tsx.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 233be51153..8278991baf 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -24,12 +24,42 @@ # Language Support +- [Astro](./languages/astro.md) +- [C](./languages/c.md) +- [C++](./languages/cpp.md) +- [C#](./languages/csharp.md) +- [Clojure](./languages/clojure.md) +- [CSS](./languages/css.md) +- [Deno](./languages/deno.md) - [Elixir](./languages/elixir.md) +- [Elm](./languages/elm.md) +- [Erlang](./languages/erlang.md) +- [Gleam](./languages/gleam.md) - [Go](./languages/go.md) +- [Haskell](./languages/haskell.md) +- [HTML](./languages/html.md) - [JavaScript](./languages/javascript.md) +- [JSON](./languages/json.md) +- [Lua](./languages/lua.md) +- [Markdown](./languages/markdown.md) +- [OCaml](./languages/ocaml.md) +- [PHP](./languages/php.md) +- [Prisma](./languages/prisma.md) +- [Proto](./languages/proto.md) +- [PureScript](./languages/purescript.md) - [Python](./languages/python.md) +- [Racket](./languages/racket.md) - [Ruby](./languages/ruby.md) - [Rust](./languages/rust.md) +- [Scheme](./languages/scheme.md) +- [Svelte](./languages/svelte.md) +- [Terraform](./languages/terraform.md) +- [TOML](./languages/toml.md) +- [TypeScript](./languages/typescript.md) +- [Uiua](./languages/uiua.md) +- [Vue](./languages/vue.md) +- [YAML](./languages/yaml.md) +- [Zig](./languages/zig.md) # Developing Zed diff --git a/docs/src/languages/astro.md b/docs/src/languages/astro.md index 6ce15792b3..1dbba8178b 100644 --- a/docs/src/languages/astro.md +++ b/docs/src/languages/astro.md @@ -1,4 +1,3 @@ # Astro -- Tree Sitter: [tree-sitter-astro](https://github.com/virchau13/tree-sitter-astro) -- Language Server: [astro](https://github.com/withastro/language-tools/tree/main/packages/language-server) +Astro support is available through the [Astro extension](https://github.com/zed-industries/zed/tree/main/extensions/astro). diff --git a/docs/src/languages/c.md b/docs/src/languages/c.md index 9afddad731..e9df6197b0 100644 --- a/docs/src/languages/c.md +++ b/docs/src/languages/c.md @@ -1,4 +1,6 @@ # C +C support is available natively in Zed. + - Tree Sitter: [tree-sitter-c](https://github.com/tree-sitter/tree-sitter-c) - Language Server: [clangd](https://github.com/clangd/clangd) diff --git a/docs/src/languages/clojure.md b/docs/src/languages/clojure.md index b89e122a56..2dd816b174 100644 --- a/docs/src/languages/clojure.md +++ b/docs/src/languages/clojure.md @@ -1,4 +1,3 @@ # Clojure -- Tree Sitter: [tree-sitter-clojure](https://github.com/prcastro/tree-sitter-clojure) -- Language Server: [clojure-lsp](https://github.com/clojure-lsp/clojure-lsp) +Clojure support is available through the [Clojure extension](https://github.com/zed-industries/zed/tree/main/extensions/clojure). diff --git a/docs/src/languages/cpp.md b/docs/src/languages/cpp.md index cfa183f71c..1cc9f99912 100644 --- a/docs/src/languages/cpp.md +++ b/docs/src/languages/cpp.md @@ -1,4 +1,6 @@ # C++ +C++ support is available natively in Zed. + - Tree Sitter: [tree-sitter-cpp](https://github.com/tree-sitter/tree-sitter-cpp) - Language Server: [clangd](https://github.com/clangd/clangd) diff --git a/docs/src/languages/csharp.md b/docs/src/languages/csharp.md index 1de49c503c..4d7342c260 100644 --- a/docs/src/languages/csharp.md +++ b/docs/src/languages/csharp.md @@ -1,4 +1,3 @@ # C# -- Tree Sitter: [tree-sitter-c-sharp](https://github.com/tree-sitter/tree-sitter-c-sharp) -- Language Server: [OmniSharp](https://github.com/OmniSharp/omnisharp-roslyn) +C# support is available through the [C# extension](https://github.com/zed-industries/zed/tree/main/extensions/csharp). diff --git a/docs/src/languages/css.md b/docs/src/languages/css.md index 4ac6b3de6c..56c55eae05 100644 --- a/docs/src/languages/css.md +++ b/docs/src/languages/css.md @@ -1,4 +1,6 @@ # CSS +CSS support is available natively in Zed. + - Tree Sitter: [tree-sitter-css](https://github.com/tree-sitter/tree-sitter-css) - Language Server: N/A diff --git a/docs/src/languages/deno.md b/docs/src/languages/deno.md index c8c492233e..0de0619a71 100644 --- a/docs/src/languages/deno.md +++ b/docs/src/languages/deno.md @@ -1,4 +1,3 @@ # Deno -- Tree Sitter: [tree-sitter-typescript](https://github.com/tree-sitter/tree-sitter-typescript) -- Language Server: [deno](https://github.com/denoland/deno) +Deno support is available through the [Deno extension](https://github.com/zed-industries/zed/tree/main/extensions/deno). diff --git a/docs/src/languages/elm.md b/docs/src/languages/elm.md index 02bd4a88a6..2297688332 100644 --- a/docs/src/languages/elm.md +++ b/docs/src/languages/elm.md @@ -1,7 +1,6 @@ # Elm -- Tree Sitter: [tree-sitter-elm](https://github.com/elm-tooling/tree-sitter-elm) -- Language Server: [elm-language-server](https://github.com/elm-tooling/elm-language-server) +Elm support is available through the [Elm extension](https://github.com/zed-industries/zed/tree/main/extensions/elm). ### Setting up `elm-language-server` @@ -21,5 +20,4 @@ Elm language server can be configured in your `settings.json`, e.g.: } ``` -`elm-format`, `elm-review` and `elm` need to be installed and made available in the environment -or configured in the settings. See the [full list of server settings here](https://github.com/elm-tooling/elm-language-server?tab=readme-ov-file#server-settings). +`elm-format`, `elm-review` and `elm` need to be installed and made available in the environment or configured in the settings. See the [full list of server settings here](https://github.com/elm-tooling/elm-language-server?tab=readme-ov-file#server-settings). diff --git a/docs/src/languages/erb.md b/docs/src/languages/erb.md deleted file mode 100644 index a94b986436..0000000000 --- a/docs/src/languages/erb.md +++ /dev/null @@ -1,4 +0,0 @@ -# ERB - -- Tree Sitter: [tree-sitter-embedded-template](https://github.com/tree-sitter/tree-sitter-embedded-template) -- Language Server: [solargraph](https://github.com/castwide/solargraph) diff --git a/docs/src/languages/erlang.md b/docs/src/languages/erlang.md index 3343168faf..13997db446 100644 --- a/docs/src/languages/erlang.md +++ b/docs/src/languages/erlang.md @@ -1,4 +1,3 @@ # Erlang -- Tree Sitter: [tree-sitter-erlang](https://github.com/WhatsApp/tree-sitter-erlang) -- Language Server: [erlang_ls](https://github.com/erlang-ls/erlang_ls) +Erlang support is available through the [Erlang extension](https://github.com/zed-industries/zed/tree/main/extensions/erlang). diff --git a/docs/src/languages/gleam.md b/docs/src/languages/gleam.md index 78fecda259..c0459a4d5b 100644 --- a/docs/src/languages/gleam.md +++ b/docs/src/languages/gleam.md @@ -1,4 +1,3 @@ # Gleam -- Tree Sitter: [tree-sitter-gleam](https://github.com/gleam-lang/tree-sitter-gleam) -- Language Server: [gleam](https://github.com/gleam-lang/gleam) +Gleam support is available through the [Gleam extension](https://github.com/zed-industries/zed/tree/main/extensions/gleam). diff --git a/docs/src/languages/haskell.md b/docs/src/languages/haskell.md index c3ac1e8860..fc273660aa 100644 --- a/docs/src/languages/haskell.md +++ b/docs/src/languages/haskell.md @@ -1,4 +1,3 @@ # Haskell -- Tree Sitter: [tree-sitter-haskell](https://github.com/tree-sitter/tree-sitter-haskell) -- Language Server: [hls](https://github.com/haskell/haskell-language-server) +Haskell support is available through the [Haskell extension](https://github.com/zed-industries/zed/tree/main/extensions/haskell). diff --git a/docs/src/languages/html.md b/docs/src/languages/html.md index f435959436..a45936c8f9 100644 --- a/docs/src/languages/html.md +++ b/docs/src/languages/html.md @@ -1,4 +1,15 @@ # HTML -- Tree Sitter: [tree-sitter-html](https://github.com/tree-sitter/tree-sitter-html) -- Language Server: [vscode-html-language-server](https://github.com/hrsh7th/vscode-langservers-extracted) +HTML support is available through the [HTML extension](https://github.com/zed-industries/zed/tree/main/extensions/html). + +This extension is automatically installed. + +If you do not want to use the HTML extension, you can add the following to your settings: + +```json +{ + "auto_install_extensions": { + "html": false + } +} +``` diff --git a/docs/src/languages/json.md b/docs/src/languages/json.md index 2eaa90b321..d77f5f3409 100644 --- a/docs/src/languages/json.md +++ b/docs/src/languages/json.md @@ -1,4 +1,6 @@ # JSON +JSON support is available natively in Zed. + - Tree Sitter: [tree-sitter-json](https://github.com/tree-sitter/tree-sitter-json) - Language Server: [json-language-server](https://github.com/zed-industries/json-language-server) diff --git a/docs/src/languages/lua.md b/docs/src/languages/lua.md index b2fa23bd27..ae869ebf8d 100644 --- a/docs/src/languages/lua.md +++ b/docs/src/languages/lua.md @@ -1,4 +1,3 @@ # Lua -- Tree Sitter: [tree-sitter-lua](https://github.com/MunifTanjim/tree-sitter-lua) -- Language Server: [lua-language-server](https://github.com/LuaLS/lua-language-server) +Lua support is available through the [Lua extension](https://github.com/zed-industries/zed/tree/main/extensions/lua). diff --git a/docs/src/languages/markdown.md b/docs/src/languages/markdown.md index ec3dadc8fa..1351e47e80 100644 --- a/docs/src/languages/markdown.md +++ b/docs/src/languages/markdown.md @@ -1,4 +1,6 @@ # Markdown +Markdown support is available natively in Zed. + - Tree Sitter: [tree-sitter-markdown](https://github.com/MDeiml/tree-sitter-markdown) - Language Server: N/A diff --git a/docs/src/languages/ocaml.md b/docs/src/languages/ocaml.md index 6670b942e1..fdcf79d748 100644 --- a/docs/src/languages/ocaml.md +++ b/docs/src/languages/ocaml.md @@ -1,13 +1,12 @@ # OCaml -- Tree Sitter: [tree-sitter-ocaml](https://github.com/tree-sitter/tree-sitter-ocaml) -- Language Server: [ocamllsp](https://github.com/ocaml/ocaml-lsp) +OCaml support is available through the [OCaml extension](https://github.com/zed-industries/zed/tree/main/extensions/ocaml). ## Setup Instructions If you have the development environment already setup, you can skip to [Launching Zed](#launching-zed) -### Using OPAM +### 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). diff --git a/docs/src/languages/php.md b/docs/src/languages/php.md index 37393b604f..880efa67c4 100644 --- a/docs/src/languages/php.md +++ b/docs/src/languages/php.md @@ -1,4 +1,3 @@ # PHP -- Tree Sitter: [tree-sitter-php](https://github.com/tree-sitter/tree-sitter-php) -- Language Server: [intelephense](https://intelephense.com/) +PHP support is available through the [PHP extension](https://github.com/zed-industries/zed/tree/main/extensions/php). diff --git a/docs/src/languages/prisma.md b/docs/src/languages/prisma.md index 935a8d3efe..9302fca17f 100644 --- a/docs/src/languages/prisma.md +++ b/docs/src/languages/prisma.md @@ -1,4 +1,3 @@ # Prisma -- Tree Sitter: [tree-sitter-prisma](https://github.com/victorhqc/tree-sitter-prisma) -- Language Server: [prisma-language-server](https://github.com/prisma/language-tools/tree/main/packages/language-server) +Prisma support is available through the [Prisma extension](https://github.com/zed-industries/zed/tree/main/extensions/prisma). diff --git a/docs/src/languages/proto.md b/docs/src/languages/proto.md index 486542a76c..73aaff68bc 100644 --- a/docs/src/languages/proto.md +++ b/docs/src/languages/proto.md @@ -1,4 +1,6 @@ # Proto +Proto support is available natively in Zed. + - Tree-Sitter: [tree-sitter-proto](https://github.com/rewinfrey/tree-sitter-proto) - Language-Server: N/A diff --git a/docs/src/languages/purescript.md b/docs/src/languages/purescript.md index 1c46886e58..f34ef23176 100644 --- a/docs/src/languages/purescript.md +++ b/docs/src/languages/purescript.md @@ -1,4 +1,3 @@ # PureScript -- Tree Sitter: [tree-sitter-purescript](https://github.com/postsolar/tree-sitter-purescript) -- Language Server: [purescript](https://github.com/nwolverson/purescript-language-server) +PureScript support is available through the [PureScript extension](https://github.com/zed-industries/zed/tree/main/extensions/purescript). diff --git a/docs/src/languages/racket.md b/docs/src/languages/racket.md index 73e6de0f9a..379a5c8348 100644 --- a/docs/src/languages/racket.md +++ b/docs/src/languages/racket.md @@ -1,4 +1,3 @@ # Racket -- Tree Sitter: [tree-sitter-racket](https://github.com/zed-industries/tree-sitter-racket) -- Language Server: N/A +Racket support is available through the [Racket extension](https://github.com/zed-industries/zed/tree/main/extensions/racket). diff --git a/docs/src/languages/ruby.md b/docs/src/languages/ruby.md index 34d3e73198..ab8f549ba4 100644 --- a/docs/src/languages/ruby.md +++ b/docs/src/languages/ruby.md @@ -2,6 +2,8 @@ Ruby support is available through the [Ruby extension](https://github.com/zed-industries/zed/tree/main/extensions/ruby). +The Ruby extension also provides support for ERB files. + ## Choosing a language server The Ruby extension offers both `solargraph` and `ruby-lsp` language server support. diff --git a/docs/src/languages/scheme.md b/docs/src/languages/scheme.md index 4662e8e183..3be418b037 100644 --- a/docs/src/languages/scheme.md +++ b/docs/src/languages/scheme.md @@ -1,4 +1,3 @@ # Scheme -- Tree Sitter: [tree-sitter-scheme](https://github.com/6cdh/tree-sitter-scheme) -- Language Server: N/A +Scheme support is available through the [Scheme extension](https://github.com/zed-industries/zed/tree/main/extensions/scheme). diff --git a/docs/src/languages/svelte.md b/docs/src/languages/svelte.md index e6b1281893..793b317492 100644 --- a/docs/src/languages/svelte.md +++ b/docs/src/languages/svelte.md @@ -1,7 +1,6 @@ # Svelte -- Tree Sitter: [tree-sitter-svelte](https://github.com/Himujjal/tree-sitter-svelte) -- Language Server: [svelte](https://github.com/sveltejs/language-tools/tree/master/packages/language-server) +Svelte support is available through the [Svelte extension](https://github.com/zed-industries/zed/tree/main/extensions/svelte). ## Inlay Hints diff --git a/docs/src/languages/terraform.md b/docs/src/languages/terraform.md index 32bfe9b4b1..894db30dea 100644 --- a/docs/src/languages/terraform.md +++ b/docs/src/languages/terraform.md @@ -1,7 +1,6 @@ # Terraform -- Tree Sitter: [tree-sitter-hcl](https://github.com/MichaHoffmann/tree-sitter-hcl) -- Language Server: [terraform-ls](https://github.com/hashicorp/terraform-ls) +Terraform support is available through the [Terraform extension](https://github.com/zed-industries/zed/tree/main/extensions/terraform). ### Configuration diff --git a/docs/src/languages/toml.md b/docs/src/languages/toml.md index 7b923ca507..5a415dfe89 100644 --- a/docs/src/languages/toml.md +++ b/docs/src/languages/toml.md @@ -1,4 +1,3 @@ # TOML -- Tree Sitter: [tree-sitter-toml](https://github.com/tree-sitter/tree-sitter-toml) -- Language Server: [taplo](https://taplo.tamasfe.dev) +TOML support is available through the [TOML extension](https://github.com/zed-industries/zed/tree/main/extensions/toml). diff --git a/docs/src/languages/tsx.md b/docs/src/languages/tsx.md deleted file mode 100644 index 63b4e927fc..0000000000 --- a/docs/src/languages/tsx.md +++ /dev/null @@ -1,4 +0,0 @@ -# TSX - -- Tree Sitter: [tree-sitter-typescript](https://github.com/tree-sitter/tree-sitter-typescript) -- Language Server: [typescript-language-server](https://github.com/typescript-language-server/typescript-language-server) diff --git a/docs/src/languages/typescript.md b/docs/src/languages/typescript.md index 7210e169e9..ce9d988dd9 100644 --- a/docs/src/languages/typescript.md +++ b/docs/src/languages/typescript.md @@ -1,5 +1,7 @@ # TypeScript +TypeScript and TSX support are available natively in Zed. + - Tree Sitter: [tree-sitter-typescript](https://github.com/tree-sitter/tree-sitter-typescript) - Language Server: [typescript-language-server](https://github.com/typescript-language-server/typescript-language-server) diff --git a/docs/src/languages/uiua.md b/docs/src/languages/uiua.md index d969424f5a..4e2a039c6d 100644 --- a/docs/src/languages/uiua.md +++ b/docs/src/languages/uiua.md @@ -1,4 +1,3 @@ # Uiua -- Tree Sitter: [tree-sitter-uiua](https://github.com/shnarazk/tree-sitter-uiua) -- Language Server: [uiua](https://github.com/uiua-lang/uiua) +Uiua support is available through the [Uiua extension](https://github.com/zed-industries/zed/tree/main/extensions/uiua). diff --git a/docs/src/languages/vue.md b/docs/src/languages/vue.md index 83c5bccbc0..38d06a6edc 100644 --- a/docs/src/languages/vue.md +++ b/docs/src/languages/vue.md @@ -1,6 +1,5 @@ # Vue -- Tree Sitter: [tree-sitter-vue](https://github.com/zed-industries/tree-sitter-vue) -- Language Server: [@vue/language-server](https://github.com/vuejs/language-tools/tree/master/packages/language-server) +Vue support is available through the [Vue extension](https://github.com/zed-industries/zed/tree/main/extensions/vue). -> Pinned `@vue/language-server` to version 1.8 until Zed supports 2.x #9846 +> `@vue/language-server` is pinned to v1.8 due to some issues in v2.x [#9846](https://github.com/zed-industries/zed/pull/9846) diff --git a/docs/src/languages/yaml.md b/docs/src/languages/yaml.md index 65e0f21145..a0ad86bf22 100644 --- a/docs/src/languages/yaml.md +++ b/docs/src/languages/yaml.md @@ -1,4 +1,6 @@ # YAML +YAML support is available natively in Zed. + - Tree Sitter: [tree-sitter-yaml](https://github.com/zed-industries/tree-sitter-yaml) - Language Server: [yaml-language-server](https://github.com/redhat-developer/yaml-language-server) diff --git a/docs/src/languages/zig.md b/docs/src/languages/zig.md index ab94b4c956..3eca03192d 100644 --- a/docs/src/languages/zig.md +++ b/docs/src/languages/zig.md @@ -1,4 +1,3 @@ # Zig -- Tree Sitter: [tree-sitter-zig](https://github.com/maxxnino/tree-sitter-zig) -- Language Server: [zls](https://github.com/zigtools/zls) +Zig support is available through the [Zig extension](https://github.com/zed-industries/zed/tree/main/extensions/zig).