{"id":13683023,"url":"https://github.com/kitten/prosemd-lsp","last_synced_at":"2025-09-25T11:48:43.093Z","repository":{"id":41173138,"uuid":"344829521","full_name":"kitten/prosemd-lsp","owner":"kitten","description":"An experimental proofreading and linting language server for markdown files ✍️","archived":false,"fork":false,"pushed_at":"2023-03-26T19:16:51.000Z","size":7161,"stargazers_count":162,"open_issues_count":6,"forks_count":9,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-05-02T05:19:24.480Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kitten.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-03-05T14:05:31.000Z","updated_at":"2024-04-04T07:30:48.000Z","dependencies_parsed_at":"2024-01-14T15:25:17.416Z","dependency_job_id":"0cc1137d-d549-4e50-a236-1be3fac1e3c2","html_url":"https://github.com/kitten/prosemd-lsp","commit_stats":{"total_commits":5,"total_committers":2,"mean_commits":2.5,"dds":"0.19999999999999996","last_synced_commit":"d6073d9ec269cec820b3efc77e0f62bcff47790e"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitten%2Fprosemd-lsp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitten%2Fprosemd-lsp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitten%2Fprosemd-lsp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kitten%2Fprosemd-lsp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kitten","download_url":"https://codeload.github.com/kitten/prosemd-lsp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247618105,"owners_count":20967726,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T13:01:57.746Z","updated_at":"2025-09-25T11:48:42.967Z","avatar_url":"https://github.com/kitten.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg\n    src=\"https://raw.githubusercontent.com/kitten/prosemd-lsp/main/vscode/icon.png\"\n    alt=\"prosemd\"\n    width=\"200\"\u003e\n\u003c/p\u003e\n\n`prosemd` is an **experimental** proofreading and linting language server for markdown files.\nIt aims to provide helpful and smart diagnostics when writing prose for technical or non-technical\ndocuments alike.\n\nUnder the hood, it integrates with any editor supporting the [Language Server\nProtocol](https://microsoft.github.io/language-server-protocol/), and uses\n[nlprule](https://github.com/bminixhofer/nlprule), which is based on\n[LanguageTool](https://github.com/languagetool-org/languagetool), to highlight possible errors and\nprovides suggestions on how to address them.\n\n\u003e **Note:** On the roadmap for more features are other useful linting rules, related to Markdown\n\u003e links, formatting, and other potentially helpful features, however for now `prosemd` is limited to\n\u003e just grammar \u0026 style correction with `nlprule` and only supports English.\n\n## Quick Start\n\n### Setup in VSCode\n\n**If you're using VSCode, all you have to do is install the `prosemd` extension.**\n\n[Install the extension from the VSCode Marketplace.](https://marketplace.visualstudio.com/items?itemName=kitten.prosemd)\n\n### Manual Installation\n\nIf you're setting the language server up with your editor of choice then you'll need to either\ndownload the executable or compile it from source:\n\n- Download the [latest release executable](https://github.com/kitten/prosemd-lsp/releases) for your\n  OS (Either: `prosemd-lsp-linux`, `prosemd-lsp-windows.exe`, or `prosemd-lsp-macos`).\n- or; install [Rust](https://www.rust-lang.org/tools/install) and then run\n  `cargo install prosemd-lsp` to compile `prosemd` from source.\n\n### Configuring [`coc.nvim`](https://github.com/neoclide/coc.nvim)\n\n[First, make sure that you install the `prosemd-lsp` executable.](#manual-installation)\n\nYou may add `prosemd` to `coc.nvim`'s config manually in `coc-settings.json` opened by the\n`:CocConfig` command, like so:\n\n```json\n{\n  \"languageserver\": {\n    \"prosemd\": {\n      \"command\": \"/usr/local/bin/prosemd-lsp\",\n      \"args\": [\"--stdio\"],\n      \"filetypes\": [\"markdown\"],\n      \"trace.server\": \"verbose\",\n      \"settings\": {\n        \"validate\": true\n      }\n    }\n  }\n}\n```\n\nDon't forget to swap out the binary's path at `command` to where you've installed the `prosemd-lsp`\nexecutable.\n\n### Configuring [`nvim-lspconfig`](https://github.com/neovim/nvim-lspconfig)\n\n[First, make sure that you install the `prosemd-lsp` executable.](#manual-installation)\n\nYou may add `prosemd` to [Neovim's built-in language server\nclient](https://neovim.io/doc/user/lsp.html) by adding it to `nvim-lspconfig`'s list of language\nservers:\n\n```lua\nlocal lsp_configs = require('lspconfig.configs')\n\nlsp_configs.prosemd = {\n  default_config = {\n    -- Update the path to prosemd-lsp\n    cmd = { \"/usr/local/bin/prosemd-lsp\", \"--stdio\" },\n    filetypes = { \"markdown\" },\n    root_dir = function(fname)\n      return lsp_util.find_git_ancestor(fname) or vim.fn.getcwd()\n    end,\n    settings = {},\n  }\n}\n\n-- Use your attach function here\nlocal lsp = require('lspconfig')\nlsp.prosemd.setup{ on_attach = on_attach }\n```\n\nDon't forget to swap out the binary's path at `cmd` to where you've installed the `prosemd-lsp`\nexecutable.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitten%2Fprosemd-lsp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkitten%2Fprosemd-lsp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkitten%2Fprosemd-lsp/lists"}