https://github.com/codedownio/markdown-spellcheck-lsp

Language Protocol Server for running spellcheck on Markdown
https://github.com/codedownio/markdown-spellcheck-lsp

Last synced: 12 months ago
JSON representation

Language Protocol Server for running spellcheck on Markdown

• Host: GitHub
• URL: https://github.com/codedownio/markdown-spellcheck-lsp
• Owner: codedownio
• Created: 2020-05-11T22:27:04.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-05T01:00:06.000Z (about 2 years ago)
• Last Synced: 2025-05-19T02:12:30.350Z (about 1 year ago)
• Language: TypeScript
• Size: 1.35 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          

# Welcome to `markdown-spellcheck-lsp`

![markdown-spellcheck-lsp](https://github.com/codedownio/markdown-spellcheck-lsp/workflows/ci/badge.svg)

This project is an [LSP server](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/) implementation which provides spellchecking suggestions on a Markdown document.

It parses the document using [remarkable](https://github.com/jonschlinkert/remarkable), a powerful and flexible Markdown parsing library. Then it looks for spelling mistakes using [Hunspell](https://github.com/hunspell/hunspell), the industry-standard spellchecking library used in many browsers and OSes.

## Example

In the Markdown below, `markdown-spellcheck-lsp` will correctly find all the misspellings and suggest alternatives, understanding the Markdown syntax and ignoring any sections (such as the URL inside a link) that should not be checked.

```markdown

# Here's a missspelling

> An blockq quote

>with multiple linesz

> and a thrd

This link **iz** also [wronggly speled](www.github.com)

```