Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sontungexpt committed Sep 17, 2023
1 parent ed61f7c commit 3ec7dc5
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ open an issue or create a pull request to fix it

## Features

- Highlight all urls in the buffer or highlight only url that can be opened
- Highlight all urls in the buffer and highlight url that can be opened when cursor move over it
- Open the url under cursor include markdown link (e.g. `https://github.com/sontungexpt/url-open`)
- Open the github page of neovim plugin name under cursor (e.g. `Plug 'nvim-lua/plenary.nvim'`, "sontungexpt/url-open")
- Open the npm package in package.json (e.g. `"lodash": "^4.17.21",`)
Expand Down Expand Up @@ -101,12 +101,20 @@ require("url_open").setup({
-- google-chrome, firefox, micorsoft-edge-stable, opera, brave, vivaldi
open_only_when_cursor_on_url = false,
highlight_url = {
enabled = true,
cursor_only = true, -- highlight only when cursor on url or highlight all urls
fg = "#199bff",
bg = nil, -- transparent
underline = true,
-- more_customize via vim.api.nvim_set_hl
all_urls = {
enabled = false,
fg = "#19d5ff", -- nil will use default color
bg = nil, -- transparent
underline = true,
-- more_customize via vim.api.nvim_set_hl
},
cursor_move = {
enabled = true,
fg = "#199eff", -- nil will use default color
bg = nil, -- transparent
underline = true,
-- more_customize via vim.api.nvim_set_hl
},
},
deep_pattern = false,
extra_patterns = {
Expand Down

0 comments on commit 3ec7dc5

Please sign in to comment.