Skip to content

Fixes #427: Update Neovim CodeLens setup docs #433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixes #427: Update Neovim CodeLens setup docs #433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 15 additions & 23 deletions docs/Markdown Oxide Docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,35 +170,27 @@ Set up the PKM for your text editor...
- <details>
<summary>(optional) Enable Code Lens (eg for UI reference count)</summary>

Modify your lsp `on_attach` function.
Neovim 0.12+ manages Code Lens refreshes automatically once enabled. Add this after `vim.lsp.enable('markdown_oxide')`, or anywhere during startup if your LSP config is enabled elsewhere:

```lua
local function codelens_supported(bufnr)
for _, c in ipairs(vim.lsp.get_clients({ bufnr = bufnr })) do
if c.server_capabilities and c.server_capabilities.codeLensProvider then
return true
end
end
return false
end
vim.lsp.codelens.enable(true)
```

vim.api.nvim_create_autocmd(
{ 'TextChanged', 'InsertLeave', 'CursorHold', 'BufEnter' },
{
buffer = bufnr,
callback = function()
if codelens_supported(bufnr) then
vim.lsp.codelens.refresh({ bufnr = bufnr })
end
end,
}
)
To enable Code Lens only when `markdown_oxide` attaches, put this in an `LspAttach` autocommand:

if codelens_supported(bufnr) then
vim.lsp.codelens.refresh({ bufnr = bufnr })
end
```lua
vim.api.nvim_create_autocmd('LspAttach', {
callback = function(args)
local client = vim.lsp.get_client_by_id(args.data.client_id)
if client and client.name == 'markdown_oxide' and client.server_capabilities.codeLensProvider then
vim.lsp.codelens.enable(true, { bufnr = args.buf, client_id = client.id })
end
end,
})
```

On Neovim <= 0.11, `vim.lsp.codelens.refresh({ bufnr = args.buf })` in autocmds is still the supported approach.

</details>

- <details>
Expand Down
38 changes: 15 additions & 23 deletions docs/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,34 +93,26 @@ Give Neovim access to the binary using one of the following installation methods
</Accordion>

<Accordion title="(optional) Enable Code Lens (eg for UI reference count)">
Modify your lsp `on_attach` function.
Neovim 0.12+ manages Code Lens refreshes automatically once enabled. Add this after `vim.lsp.enable('markdown_oxide')`, or anywhere during startup if your LSP config is enabled elsewhere:

```lua
local function codelens_supported(bufnr)
for _, c in ipairs(vim.lsp.get_clients({ bufnr = bufnr })) do
if c.server_capabilities and c.server_capabilities.codeLensProvider then
return true
end
end
return false
end
vim.lsp.codelens.enable(true)
```

vim.api.nvim_create_autocmd(
{ 'TextChanged', 'InsertLeave', 'CursorHold', 'BufEnter' },
{
buffer = bufnr,
callback = function()
if codelens_supported(bufnr) then
vim.lsp.codelens.refresh({ bufnr = bufnr })
end
end,
}
)
To enable Code Lens only when `markdown_oxide` attaches, put this in an `LspAttach` autocommand:

if codelens_supported(bufnr) then
vim.lsp.codelens.refresh({ bufnr = bufnr })
end
```lua
vim.api.nvim_create_autocmd('LspAttach', {
callback = function(args)
local client = vim.lsp.get_client_by_id(args.data.client_id)
if client and client.name == 'markdown_oxide' and client.server_capabilities.codeLensProvider then
vim.lsp.codelens.enable(true, { bufnr = args.buf, client_id = client.id })
end
end,
})
```

On Neovim <= 0.11, `vim.lsp.codelens.refresh({ bufnr = args.buf })` in autocmds is still the supported approach.
</Accordion>

<Accordion title="(optional) Enable opening daily notes with natural language">
Expand Down
Loading