Skip to content

Commit f66e583

Browse files
authored
README: Added Helix install section (#53)
* README: Added Helix section Fixes: #30 * README: Removed 'only' from Zed section
1 parent a08508e commit f66e583

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,43 @@
1717

1818
No setup needed. Code book will automatically detect the language you are editing and mark issues for you. Note, Codebook will only mark issues for words that you control, where they are initially defined.
1919

20-
## Install
20+
## Integrations
2121

22-
Codebook is currently only available for the Zed editor. To install, go to the Extension tab in Zed and look for "Codebook".
22+
### Zed
23+
24+
Codebook is available for the Zed editor. To install, go to the Extension tab in Zed and look for "Codebook".
2325

2426
**Note**: The version that Zed displays in the extension menus is for the [Zed Extension](https://github.com/blopker/codebook-zed), and not the LSP version (this repo). The extension will automatically update the LSP. If that updater is broken for some reason, try uninstalling the extension and reinstalling.
2527

28+
### Helix
29+
30+
Codebook can also be enabled for the [Helix
31+
editor](https://helix-editor.com/) by adding the LSP to the
32+
[language.toml](https://docs.helix-editor.com/languages.html) configuration
33+
file. Ensure that `codebook-lsp` is installed into your `$PATH` and add into
34+
this file:
35+
36+
```toml
37+
[language-server.codebook]
38+
command = "codebook-lsp"
39+
args = ["serve"]
40+
41+
# Example use in markdown:
42+
[[language]]
43+
name = "markdown"
44+
language-servers = ["codebook"]
45+
```
46+
47+
This can be verified with:
48+
49+
```shell
50+
hx --health markdown
51+
```
52+
53+
Suggestions will appear in files opened, and
54+
[space-mode](https://docs.helix-editor.com/keymap.html#space-mode) `a` key
55+
binding can be used to accept suggestions.
56+
2657
## About
2758

2859
Codebook is a spellchecker for code. It binds together the venerable Tree Sitter and the fast spell checker [Spellbook](https://github.com/helix-editor/spellbook). Included is a Language Server for use in (theoretically) any editor. Everything is done in Rust to keep response times snappy and memory usage _low_.

0 commit comments

Comments
 (0)