Skip to content

Commit

Permalink
docs: Update Ruby docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maxdeviant committed May 25, 2024
1 parent 461e7d0 commit e2ba192
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions docs/src/languages/ruby.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,25 @@
- Tree Sitter: [tree-sitter-ruby](https://github.com/tree-sitter/tree-sitter-ruby)
- Language Servers: [solargraph](https://github.com/castwide/solargraph), [ruby-lsp](https://github.com/Shopify/ruby-lsp)

### Setting up `solargraph`
## Choosing a language server

The Ruby extension offers both `solargraph` and `ruby-lsp` language server support.

`solargraph` is enabled by default.

To switch to `ruby-lsp`, add the following to your `settings.json`:

```json
{
"languages": {
"Ruby": {
"language_servers": ["ruby-lsp", "..."]
}
}
}
```

## Setting up `solargraph`

Zed currently doesn't install Solargraph automatically. To use Solargraph, you need to install the gem. Zed just looks for an executable called `solargraph` on your `PATH`.

Expand Down Expand Up @@ -38,7 +56,7 @@ Solargraph has formatting and diagnostics disabled by default. We can tell Zed t

Solargraph reads its configuration from a file called `.solargraph.yml` in the root of your project. For more information about this file, see the [Solargraph configuration documentation](https://solargraph.org/guides/configuration).

### Setting up `ruby-lsp`
## Setting up `ruby-lsp`

Zed currently doesn't install Ruby LSP automatically. To use Ruby LSP, you need to install the gem. Zed just looks for an executable called `ruby-lsp` on your `PATH`.

Expand Down

0 comments on commit e2ba192

Please sign in to comment.