DanRoscigno / nvim-markdown-grammarly

Minimal nvim all lua config for Markdown with Grammarly

nvim-markdown-grammarly

Minimal nvim lua config for Markdown with Grammarly

Requirements

Use the VS Code Grammarly plugin:

• clone znck/grammarly
• run the install and build commands:

  pnpm install
  pnpm run build

• run the pnpmm test and verify that markdown passes

  pnpm test

  > @ test /home/droscigno/GitHub/grammarly
  > jest
  
   PASS  packages/grammarly-richtext-encoder/test/markdown.test.ts
    markdown
      ✓ encode (76 ms)
      ✓ decode (1 ms)
  
  Test Suites: 1 passed, 1 total
  Tests:       2 passed, 2 total
  Snapshots:   2 passed, 2 total
  Time:        0.344 s, estimated 2 s
  Ran all test suites.
  

• find the binary file grammarly-languageserver in a subdir of the znck/grammarly repo

  find . | grep "bin\/grammarly-languageserver"

  ./extension/node_modules/.bin/grammarly-languageserver
  

  Run the languageserver to make sure it starts:

  ./extension/node_modules/.bin/grammarly-languageserver --stdio

  Content-Length: 85
  
  {"jsonrpc":"2.0","method":"window/logMessage","params":{"type":4,"message":"Ready!"}}^C
  

Configure neovim

• remove $HOME/.config/nvim
• link this repo to $HOME/.config/nvim
• edit lua/grammarly.lua and set the Grammarly LSP cmd (using the one you just built in the znck/grammarly dir)

Test

• edit a markdown file (this one will show some issues). You should see marks in the far left column indicating grammar and spelling errors. Navigate through the errors with ]d
• add a link to a non-existent markdown file, for example, [foo](./foo.md). This will show as a warning from Marksman if you add it outside of a code block. foo