Merge branch 'main' of github.com:chipsenkbeil/org-mouse.nvim

doc/org-mouse.txt

@@ -0,0 +1,132 @@
+*org-mouse.txt*           For NVIM v0.9.2           Last change: 2024 April 11
+
+==============================================================================
+Table of Contents                                *org-mouse-table-of-contents*
+
+1. Installation                                       |org-mouse-installation|
+  - lazy.nvim (recommended)   |org-mouse-installation-lazy.nvim-(recommended)|
+  - packer.nvim                           |org-mouse-installation-packer.nvim|
+2. Examples                                               |org-mouse-examples|
+  - Link Highlighting by Hover |org-mouse-examples-link-highlighting-by-hover|
+  - Navigating Links by Click   |org-mouse-examples-navigating-links-by-click|
+3. Configuration                                     |org-mouse-configuration|
+  - clickopenlinks                    |org-mouse-configuration-clickopenlinks|
+  - highlightlinks                    |org-mouse-configuration-highlightlinks|
+  - highlightlinksgroup          |org-mouse-configuration-highlightlinksgroup|
+  - filetypes                              |org-mouse-configuration-filetypes|
+Adds mouse features to neovim <https://neovim.io/> using nvim-orgmode
+<https://github.com/nvim-orgmode/orgmode>.
+
+Requires **neovim 0.9.2+**.
+
+
+==============================================================================
+1. Installation                                       *org-mouse-installation*
+
+This plugin depends on nvim-orgmode/orgmode
+<https://github.com/nvim-orgmode/orgmode>.
+
+
+LAZY.NVIM (RECOMMENDED)       *org-mouse-installation-lazy.nvim-(recommended)*
+
+>lua
+    {
+      "chipsenkbeil/org-mouse.nvim",
+      dependencies = { "nvim-orgmode/orgmode" },
+      config = function()
+        require("org-mouse").setup()
+      end
+    }
+<
+
+
+PACKER.NVIM                               *org-mouse-installation-packer.nvim*
+
+>lua
+    use {
+      "chipsenkbeil/org-mouse.nvim",
+      requires = { "nvim-orgmode/orgmode" },
+      config = function()
+        require("org-mouse"):setup()
+      end
+    }
+<
+
+
+==============================================================================
+2. Examples                                               *org-mouse-examples*
+
+
+LINK HIGHLIGHTING BY HOVER     *org-mouse-examples-link-highlighting-by-hover*
+
+
+NAVIGATING LINKS BY CLICK       *org-mouse-examples-navigating-links-by-click*
+
+
+==============================================================================
+3. Configuration                                     *org-mouse-configuration*
+
+
+CLICKOPENLINKS                        *org-mouse-configuration-clickopenlinks*
+
+If true, clicking on links will open them.
+
+Takes a boolean. Defaults to `true`.
+
+>lua
+    require("org-mouse"):setup({
+      click_open_links = false,
+    })
+<
+
+
+HIGHLIGHTLINKS                        *org-mouse-configuration-highlightlinks*
+
+If true, highlights links when mousing over them.
+
+This will enable `vim.opt.mouseoverevent` if disabled!
+
+Takes a boolean. Defaults to `true`.
+
+>lua
+    require("org-mouse"):setup({
+      highlight_links = false,
+    })
+<
+
+
+HIGHLIGHTLINKSGROUP              *org-mouse-configuration-highlightlinksgroup*
+
+Highlight group to apply when highlighting links.
+
+Takes a string. Defaults to `WarningMsg`.
+
+>lua
+    require("org-mouse"):setup({
+      highlight_links_group = "Comment",
+    })
+<
+
+
+FILETYPES                                  *org-mouse-configuration-filetypes*
+
+Specifies filetypes where mouse events will be bound.
+
+This is leveraged during setup to configure a `FileType` autocmd to attach
+keybindings for `<MouseMove>` and `<LeftRelease>` to support mouse
+interactions.
+
+Takes a list of strings. Defaults to `{"org", "org-roam-*"}`.
+
+Notice that the strings are in pattern format, meaning you can use wildcards to
+support multiple filetypes.
+
+>lua
+    require("org-mouse"):setup({
+      filetypes = { "org", "org-roam-*", "org-custom-*" },
+    })
+<
+
+Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
+
+vim:tw=78:ts=8:noet:ft=help:norl: