Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

docs(ls): wrote instructions for isolating English in `harper-ls`

Elijah Potter32bf9f4a9acb
diff --git a/packages/web/src/routes/docs/integrations/neovim/+page.md b/packages/web/src/routes/docs/integrations/neovim/+page.md
index 036ad64aa..96bf325f9 100644
--- a/packages/web/src/routes/docs/integrations/neovim/+page.md
+++ b/packages/web/src/routes/docs/integrations/neovim/+page.md
@@ -114,3 +114,22 @@ lspconfig.harper_ls.setup {
},
}
```
+
+If you work with a lot of documents that are a mixture of English and another language, Harper can attempt to automatically detect which is which and only lint the English text.
+To enable it, just set the `isolateEnglish` key.
+
+:::note
+This feature is incredibly new and unstable.
+Do not expect it to work perfectly.
+If improvements are important to you, feel free to [open an issue](https://github.com/Automattic/harper/issues/new?template=Blank+issue) to let us know.
+:::
+
+```lua
+lspconfig.harper_ls.setup {
+ settings = {
+ ["harper-ls"] = {
+ isolateEnglish = false
+ }
+ },
+}
+```