From 39c18f06720707f34c31920335220beedb22f64d Mon Sep 17 00:00:00 2001 From: Tran Vo Son Tung Date: Sat, 16 Sep 2023 11:07:33 +0700 Subject: [PATCH] docs: update README, docs --- README.md | 1 + docs/index.html | 2 +- docs/modules/url-open.html | 2 +- docs/modules/url-open.modules.autocmd.html | 46 ++++++++++++++++++++- docs/modules/url-open.modules.commands.html | 2 +- docs/modules/url-open.modules.handlers.html | 14 +++++-- docs/modules/url-open.modules.logger.html | 2 +- docs/modules/url-open.modules.options.html | 2 +- docs/modules/url-open.modules.patterns.html | 2 +- docs/topics/README.md.html | 2 +- 10 files changed, 64 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e0bc041..9723f28 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,7 @@ require("url_open").setup({ fg = "#199bff", bg = nil, -- transparent underline = true, + -- more_customize via vim.api.nvim_set_hl }, deep_pattern = false, extra_patterns = { diff --git a/docs/index.html b/docs/index.html index b241934..6e9970c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -95,7 +95,7 @@

Topics

generated by LDoc 1.5.0 -Last updated 2023-09-15 21:22:34 +Last updated 2023-09-16 11:05:12
diff --git a/docs/modules/url-open.html b/docs/modules/url-open.html index 5dae8bf..fbf8a7e 100644 --- a/docs/modules/url-open.html +++ b/docs/modules/url-open.html @@ -114,7 +114,7 @@

Usage:

generated by LDoc 1.5.0 -Last updated 2023-09-15 21:22:34 +Last updated 2023-09-16 11:05:12
diff --git a/docs/modules/url-open.modules.autocmd.html b/docs/modules/url-open.modules.autocmd.html index 43b71db..fc75078 100644 --- a/docs/modules/url-open.modules.autocmd.html +++ b/docs/modules/url-open.modules.autocmd.html @@ -65,6 +65,10 @@

Module url-open.modules.autocmd

Functions

+ + + + @@ -78,6 +82,46 @@

Functions

Functions

+
+ + change_color_highlight (user_opts, group_name) +
+
+ Change the color of the highlight + + +

Parameters:

+
    +
  • user_opts + table + : The user options +
    • +
  • group_name + string + : The name of the highlight group +
    • +
+ +

Returns:

+
    + + nil + + + +
+ + +

See also:

+ + + +
setup (user_opts) @@ -120,7 +164,7 @@

See also:

generated by LDoc 1.5.0 -Last updated 2023-09-15 21:22:34 +Last updated 2023-09-16 11:05:12
diff --git a/docs/modules/url-open.modules.commands.html b/docs/modules/url-open.modules.commands.html index 0108738..e96e11a 100644 --- a/docs/modules/url-open.modules.commands.html +++ b/docs/modules/url-open.modules.commands.html @@ -114,7 +114,7 @@

Usage:

generated by LDoc 1.5.0 -Last updated 2023-09-15 21:22:34 +Last updated 2023-09-16 11:05:12
diff --git a/docs/modules/url-open.modules.handlers.html b/docs/modules/url-open.modules.handlers.html index 1ac4f0f..e2d18ed 100644 --- a/docs/modules/url-open.modules.handlers.html +++ b/docs/modules/url-open.modules.handlers.html @@ -87,7 +87,7 @@

Functions

If there is only one url in the line, then open it anywhere in the line.
- +
change_color_highlight (user_opts, group_name)Change the color of the highlight
setup (user_opts) Setup the autocmds
set_url_effect ()set_url_effect (user_opts) Add syntax matching rules for highlighting URLs/URIs.
@@ -225,12 +225,20 @@

Parameters:

- set_url_effect () + set_url_effect (user_opts)
Add syntax matching rules for highlighting URLs/URIs. +

Parameters:

+ @@ -248,7 +256,7 @@

See also:

generated by LDoc 1.5.0 -Last updated 2023-09-15 21:22:34 +Last updated 2023-09-16 11:05:12
diff --git a/docs/modules/url-open.modules.logger.html b/docs/modules/url-open.modules.logger.html index 4dc7754..c758d68 100644 --- a/docs/modules/url-open.modules.logger.html +++ b/docs/modules/url-open.modules.logger.html @@ -261,7 +261,7 @@

Parameters:

generated by LDoc 1.5.0 -Last updated 2023-09-15 21:22:34 +Last updated 2023-09-16 11:05:12
diff --git a/docs/modules/url-open.modules.options.html b/docs/modules/url-open.modules.options.html index c9101e3..4d1d288 100644 --- a/docs/modules/url-open.modules.options.html +++ b/docs/modules/url-open.modules.options.html @@ -191,7 +191,7 @@

Fields:

generated by LDoc 1.5.0 -Last updated 2023-09-15 21:22:34 +Last updated 2023-09-16 11:05:12
diff --git a/docs/modules/url-open.modules.patterns.html b/docs/modules/url-open.modules.patterns.html index df59dfe..7982ea1 100644 --- a/docs/modules/url-open.modules.patterns.html +++ b/docs/modules/url-open.modules.patterns.html @@ -189,7 +189,7 @@

Fields

generated by LDoc 1.5.0 -Last updated 2023-09-15 21:22:34 +Last updated 2023-09-16 11:05:12
diff --git a/docs/topics/README.md.html b/docs/topics/README.md.html index 2f2cb68..119dda4 100644 --- a/docs/topics/README.md.html +++ b/docs/topics/README.md.html @@ -206,7 +206,7 @@

License

generated by LDoc 1.5.0 -Last updated 2023-09-15 21:22:34 +Last updated 2023-09-16 11:05:12