feat: open in the browser

included the original link in index.json and add mappings
NOTE: docs must be rebuilt in order to use this feature

Author: luckasRanarison

README.md

@@ -72,6 +72,9 @@ Here is the default configuration:
   cmd_ignore = {}, -- ignore cmd rendering for the listed docs
   picker_cmd = false, -- use cmd previewer in picker preview
   picker_cmd_args = {}, -- example using glow: { "-p" }
+  mappings = { -- keymaps for the doc buffer
+    open_in_browser = ""
+  }
   ensure_installed = {}, -- get automatically installed
   after_open = function(bufnr) end, -- callback that runs after the Devdocs window is opened. Devdocs buffer ID will be passed in
 }

lua/nvim-devdocs/build.lua

@@ -52,6 +52,7 @@ local function build_docs(entry, index, docs)
 
   for i, index_entry in ipairs(index.entries) do
     local main = vim.split(index_entry.path, "#")[1]
+    index.entries[i].link = index.entries[i].path
     index.entries[i].path = path_map[index_entry.path] or path_map[main]
   end
 

lua/nvim-devdocs/config.lua

@@ -16,7 +16,10 @@ local config = {
   picker_cmd = false,
   picker_cmd_args = {},
   ensure_installed = {},
-  after_open = function() end
+  mappings = {
+    open_in_browser = "",
+  },
+  after_open = function() end,
 }
 
 M.get = function() return config end

lua/nvim-devdocs/operations.lua

@@ -178,6 +178,7 @@ M.get_all_entries = function()
         name = string.format("[%s] %s", alias, doc_entry.name),
         alias = alias,
         path = doc_entry.path,
+        link = doc_entry.link,
       }
       table.insert(entries, entry)
     end
@@ -186,7 +187,7 @@ M.get_all_entries = function()
   return entries
 end
 
-M.open = function(alias, bufnr, pattern, float)
+M.open = function(entry, bufnr, pattern, float)
   vim.api.nvim_buf_set_option(bufnr, "modifiable", false)
 
   if not float then
@@ -210,7 +211,7 @@ M.open = function(alias, bufnr, pattern, float)
 
   vim.fn.search(pattern)
 
-  local ignore = vim.tbl_contains(plugin_config.cmd_ignore, alias)
+  local ignore = vim.tbl_contains(plugin_config.cmd_ignore, entry.alias)
   if plugin_config.previewer_cmd and not ignore then
     vim.bo[bufnr].ft = "glow"
 
@@ -238,6 +239,18 @@ M.open = function(alias, bufnr, pattern, float)
     vim.bo[bufnr].ft = "markdown"
   end
 
+  local slug = entry.alias:gsub("-", "~")
+  local keymaps = plugin_config.mappings
+  local set_buf_keymap = function(key, action, description)
+    vim.keymap.set("n", key, action, { buffer = bufnr, desc = description })
+  end
+
+  set_buf_keymap(
+    keymaps.open_in_browser,
+    function() vim.ui.open("https://devdocs.io/" .. slug .. "/" .. entry.link) end,
+    "Open in the browser"
+  )
+
   plugin_config.after_open(bufnr)
 end
 

lua/nvim-devdocs/pickers.lua

@@ -104,7 +104,7 @@ local open_doc = function(float)
 
   local splited_path = vim.split(selection.value.path, ",")
 
-  operations.open(selection.value.alias, bufnr, splited_path[2], float)
+  operations.open(selection.value, bufnr, splited_path[2], float)
 end
 
 M.installation_picker = function()