Skip to content

Commit 95994ad

Browse files
chore: remove engine specific completions from documentation
## Details Using engine specific (nvim-cmp / blink.cmp) completions offers no benefit compared to the in process LSP method, either than maybe more control over order. In either case I will likely deprecate these at some point, for now removing them from the README to avoid more users.
1 parent e76eb2e commit 95994ad

File tree

3 files changed

+5
-45
lines changed

3 files changed

+5
-45
lines changed

README.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -133,28 +133,11 @@ the relevant setup.
133133
The recommended way of getting completions from this plugin. Only requires being
134134
enabled with no additional configuration, assuming you have general LSP completions.
135135

136-
```lua
137-
require('render-markdown').setup({
138-
completions = { lsp = { enabled = true } },
139-
})
140-
```
141-
142-
## nvim-cmp
143-
144-
```lua
145-
local cmp = require('cmp')
146-
cmp.setup({
147-
sources = cmp.config.sources({
148-
{ name = 'render-markdown' },
149-
}),
150-
})
151-
```
152-
153-
## blink.cmp
136+
Works automatically with `nvim-cmp` and `blink.cmp`.
154137

155138
```lua
156139
require('render-markdown').setup({
157-
completions = { blink = { enabled = true } },
140+
completions = { lsp = { enabled = true } },
158141
})
159142
```
160143

doc/render-markdown.txt

Lines changed: 3 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*render-markdown.txt* For NVIM v0.11.3 Last change: 2025 August 29
1+
*render-markdown.txt* For NVIM v0.11.4 Last change: 2025 September 07
22

33
==============================================================================
44
Table of Contents *render-markdown-table-of-contents*
@@ -13,8 +13,6 @@ Table of Contents *render-markdown-table-of-contents*
1313
5. Commands |render-markdown-commands|
1414
6. Completions |render-markdown-completions|
1515
- in-process lsp |render-markdown-completions-in-process-lsp|
16-
- nvim-cmp |render-markdown-completions-nvim-cmp|
17-
- blink.cmp |render-markdown-completions-blink.cmp|
1816
- coq_nvim |render-markdown-completions-coq_nvim|
1917
7. Setup |render-markdown-setup|
2018
- Headings |render-markdown-setup-headings|
@@ -194,30 +192,11 @@ The recommended way of getting completions from this plugin. Only requires
194192
being enabled with no additional configuration, assuming you have general LSP
195193
completions.
196194

197-
>lua
198-
require('render-markdown').setup({
199-
completions = { lsp = { enabled = true } },
200-
})
201-
<
202-
203-
204-
NVIM-CMP *render-markdown-completions-nvim-cmp*
205-
206-
>lua
207-
local cmp = require('cmp')
208-
cmp.setup({
209-
sources = cmp.config.sources({
210-
{ name = 'render-markdown' },
211-
}),
212-
})
213-
<
214-
215-
216-
BLINK.CMP *render-markdown-completions-blink.cmp*
195+
Works automatically with `nvim-cmp` and `blink.cmp`.
217196

218197
>lua
219198
require('render-markdown').setup({
220-
completions = { blink = { enabled = true } },
199+
completions = { lsp = { enabled = true } },
221200
})
222201
<
223202

lua/render-markdown/integ/blink.lua

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
---@module 'blink.cmp'
2-
31
local source = require('render-markdown.integ.source')
42

53
---@class render.md.source.blink.Config

0 commit comments

Comments
 (0)