Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
docs(emacs): update page + remove unneeded links
Matthew Espinocbc819175c3a
diff --git a/packages/web/src/routes/docs/integrations/emacs/+page.md b/packages/web/src/routes/docs/integrations/emacs/+page.mdindex 61d40420d..72a34dd88 100644--- a/packages/web/src/routes/docs/integrations/emacs/+page.md+++ b/packages/web/src/routes/docs/integrations/emacs/+page.md@@ -2,5 +2,51 @@title: Emacs----Our Emacs support is limited and primarily provided by the community.-You can see the longer discussion [here](https://github.com/Automattic/harper/discussions/150).+Our Emacs integration is powered by [`harper-ls`](./language-server).++## Installation++Since version 29, Emacs has had native support for the Language Server Protocol through [Eglot](https://www.gnu.org/software/emacs/manual/html_mono/eglot.html), 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 `init.el` to get up and running:++```elisp title=init.el+(with-eval-after-load 'eglot+ (add-to-list 'eglot-server-programs+ '(major-mode . ("harper-ls" "--stdio"))))+```++`major-mode` can be set to any, some, or all major modes that correspond to the [languages that `harper-ls` supports](./language-server#Supported-Languages). 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:++```elisp title=init.el+(setq-default eglot-workspace-configuration+ '(:harper-ls (:userDictPath ""+ :fileDictPath ""+ :linters (:SpellCheck t+ :SpelledNumbers :json-false+ :AnA t+ :SentenceCapitalization t+ :UnclosedQuotes t+ :WrongQuotes :json-false+ :LongSentences t+ :RepeatedWords t+ :Spaces t+ :Matcher t+ :CorrectNumberSuffix t)+ :codeActions (:ForceStable :json-false)+ :markdown (:IgnoreLinkTitle :json-false)+ :diagnosticSeverity "hint"+ :isolateEnglish :json-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++- [Community discussion on configuring `harper-ls` for Emacs](https://github.com/Automattic/harper/discussions/150)diff --git a/packages/web/src/routes/docs/integrations/language-server/+page.md b/packages/web/src/routes/docs/integrations/language-server/+page.mdindex 1326590d6..b3d2c6f38 100644--- a/packages/web/src/routes/docs/integrations/language-server/+page.md+++ b/packages/web/src/routes/docs/integrations/language-server/+page.md@@ -180,9 +180,9 @@ These configs are under the `codeActions` key:}```-| Config | Type | Default Value | Description |-| ------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |-| `ForceStable` | `boolean` | `false` | Make code actions appear in "stable" positions by placing code actions that should always be available, like adding misspelled words in the dictionary, first. See [issue #89](https://github.com/automattic/harper/issues/89) for more details. |+| Config | Type | Default Value | Description |+| ------------- | --------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| `ForceStable` | `boolean` | `false` | Make code actions appear in "stable" positions by placing code actions that should always be available, like adding misspelled words in the dictionary, first. |### Markdown@@ -198,9 +198,9 @@ These configs are under the `markdown` key:}```-| Config | Type | Default Value | Description |-| ----------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------- |-| `IgnoreLinkTitle` | `boolean` | `false` | Skip linting link titles. See [issue #104](https://github.com/automattic/harper/issues/104) for more details. |+| Config | Type | Default Value | Description |+| ----------------- | --------- | ------------- | ------------------------- |+| `IgnoreLinkTitle` | `boolean` | `false` | Skip linting link titles. |### Other Configsdiff --git a/packages/web/vite.config.ts b/packages/web/vite.config.tsindex 4e1152905..cb0470001 100644--- a/packages/web/vite.config.ts+++ b/packages/web/vite.config.ts@@ -155,7 +155,8 @@ export default defineConfig({'toml','rust','lua',- 'json'+ 'json',+ 'elisp']}})