Skip to content

Snacks integration example #5

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

Merged
maskudo merged 2 commits into from
Feb 22, 2025
Merged

Snacks integration example #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
441bdfc
feat: get docs dir
maskudo Feb 22, 2025
aa05fa7
feat: snacks picker usage example
maskudo Feb 22, 2025
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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ A [devdocs](https://devdocs.io) client
{
"maskudo/devdocs.nvim",
lazy = false,
dependencies = {
"folke/snacks.nvim",
},
keys = {
{
"<leader>ho",
Expand All @@ -27,6 +30,23 @@ A [devdocs](https://devdocs.io) client
"<cmd>DevDocs install<cr>",
desc = "Install Devdocs",
},
{
"<leader>hv",
mode = "n",
function()
local devdocs = require("devdocs")
local installedDocs = devdocs.GetInstalledDocs()
vim.ui.select(installedDocs, {}, function(selected)
if not selected then
return
end
local docDir = devdocs.GetDocDir(selected)
-- prettify the filename as you wish
Snacks.picker.files({ cwd = docDir })
end)
end,
desc = "View Devdocs",
},
},
opts = {
ensure_installed = {
Expand Down
8 changes: 8 additions & 0 deletions lua/devdocs/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ local M = {}
local D = require('devdocs.docs')

local P = require('devdocs.picker')
local C = require('devdocs.constants')

---Download docs from ensure installed docs list
---@private
Expand Down Expand Up @@ -142,6 +143,13 @@ M.GetDoc = function(doc)
return D.GetDocFiles(doc)
end

--- Get directory for a doc
--- @param doc doc
--- @return [string] | nil
M.GetDocDir = function(doc)
return C.DOCS_DIR .. '/' .. doc
end

--- Install Doc
--- @async
--- @param doc doc
Expand Down