Skip to content

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

docs(helix): update page + some fixes in other pages

Matthew Espinoebdfafbb1968
diff --git a/packages/web/src/routes/docs/integrations/helix/+page.md b/packages/web/src/routes/docs/integrations/helix/+page.md
index 0536aa594..d6a89b1bd 100644
--- a/packages/web/src/routes/docs/integrations/helix/+page.md
+++ b/packages/web/src/routes/docs/integrations/helix/+page.md
@@ -1,15 +1,59 @@
---
-title: Helix Support
+title: Helix
---
-To use Harper in [Helix](https://helix-editor.com/), you'll need to have `harper-ls` installed.
+Our Helix integration is powered by [`harper-ls`](./language-server).
-Once you do, add this to you configuration:
+## Installation
-```toml
+[Helix supports language servers out-of-the-box](https://docs.helix-editor.com/languages.html#language-server-configuration), so all you have to do is [install `harper-ls` in your system](./language-server#Installation).
+
+## Configuration
+
+This the minimum you need to add to your `languages.toml` to get up and running:
+
+```toml title=languages.toml
[language-server.harper-ls]
command = "harper-ls"
args = ["--stdio"]
```
-Helix has [official documentation](https://github.com/helix-editor/helix/wiki/Language-Server-Configurations#harper-ls) as well.
+Additionally, you can also configure things like which linters to use or how you want code actions to appear. Below is an example config where everything is set to their default values:
+
+```toml title=languages.toml
+[language-server.harper-ls.config.harper-ls]
+userDictPath = ""
+fileDictPath = ""
+diagnosticSeverity = "hint"
+isolateEnglish = false
+
+[language-server.harper-ls.config.harper-ls.linters]
+SpellCheck = true
+SpelledNumbers = false
+AnA = true
+SentenceCapitalization = true
+UnclosedQuotes = true
+WrongQuotes = false
+LongSentences = true
+RepeatedWords = true
+Spaces = true
+Matcher = true
+CorrectNumberSuffix = true
+
+[language-server.harper-ls.config.harper-ls.codeActions]
+ForceStable = false
+
+[language-server.harper-ls.config.harper-ls.markdown]
+IgnoreLinkTitle = false
+```
+
+:::note
+This example only contains some of the available linters, check out our [rules page](../rules) to view the full list.
+:::
+
+For more information on what each of these configs do, you can head over to the [configuration section](./language-server#Configuration) of our `harper-ls` documentation.
+
+### Additional Links
+
+- [Helix's official documentation on `harper-ls`](https://github.com/helix-editor/helix/wiki/Language-Server-Configurations#harper-ls).
+- [Community discussion on configuring `harper-ls` for Helix](https://github.com/Automattic/harper/discussions/135)
diff --git a/packages/web/src/routes/docs/integrations/language-server/+page.md b/packages/web/src/routes/docs/integrations/language-server/+page.md
index 8be0336c5..1326590d6 100644
--- a/packages/web/src/routes/docs/integrations/language-server/+page.md
+++ b/packages/web/src/routes/docs/integrations/language-server/+page.md
@@ -192,7 +192,7 @@ These configs are under the `markdown` key:
{
"harper-ls": {
"markdown": {
- // Your markdown go here...
+ // Your Markdown configs go here...
}
}
}
diff --git a/packages/web/src/routes/docs/integrations/neovim/+page.md b/packages/web/src/routes/docs/integrations/neovim/+page.md
index 26a98c691..10737e9ae 100644
--- a/packages/web/src/routes/docs/integrations/neovim/+page.md
+++ b/packages/web/src/routes/docs/integrations/neovim/+page.md
@@ -29,13 +29,13 @@ lspconfig.harper_ls.setup {
RepeatedWords = true,
Spaces = true,
Matcher = true,
- CorrectNumberSuffix = true,
+ CorrectNumberSuffix = true
},
codeActions = {
ForceStable = false
},
markdown = {
- IgnoreLinkTitle = false,
+ IgnoreLinkTitle = false
},
diagnosticSeverity = "hint",
isolateEnglish = false
@@ -45,7 +45,7 @@ lspconfig.harper_ls.setup {
```
:::note
-This example only containes some of the available linters, head over to our [rules page](../rules) to view the full list.
+This example only contains some of the available linters, check out our [rules page](../rules) to view the full list.
:::
For more information on what each of these configs do, you can head over to the [configuration section](./language-server#Configuration) of our `harper-ls` documentation.