Skip to content

Commit

Permalink
docs: update README, docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sontungexpt
sontungexpt committed Sep 16, 2023
1 parent fb23677 commit 39c18f0
Show file tree
Hide file tree
Showing 10 changed files with 64 additions and 11 deletions.
1 change: 1 addition & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h2>Topics</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-15 21:22:34 </i>
<i style="float:right;">Last updated 2023-09-16 11:05:12 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/url-open.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-15 21:22:34 </i>
<i style="float:right;">Last updated 2023-09-16 11:05:12 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->

Expand Down
46 changes: 45 additions & 1 deletion docs/modules/url-open.modules.autocmd.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ <h1>Module <code>url-open.modules.autocmd</code></h1>

<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#change_color_highlight">change_color_highlight (user_opts, group_name)</a></td>
<td class="summary">Change the color of the highlight</td>
</tr>
<tr>
<td class="name" nowrap><a href="#setup">setup (user_opts)</a></td>
<td class="summary">Setup the autocmds</td>
Expand All @@ -78,6 +82,46 @@ <h2><a href="#Functions">Functions</a></h2>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>

<dl class="function">
<dt>
<a name = "change_color_highlight"></a>
<strong>change_color_highlight (user_opts, group_name)</strong>
</dt>
<dd>
Change the color of the highlight


<h3>Parameters:</h3>
<ul>
<li><span class="parameter">user_opts</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.6">table</a></span>
: The user options
</li>
<li><span class="parameter">group_name</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.4/manual.html#6.4">string</a></span>
: The name of the highlight group
</li>
</ul>

<h3>Returns:</h3>
<ol>

<span class="types"><span class="type">nil</span></span>



</ol>


<h3>See also:</h3>
<ul>
<li><a href="../modules/url-open.modules.handlers.html#highlight_cursor_url">url-open.modules.handlers.highlight_cursor_url</a></li>
<li><a href="../modules/url-open.modules.handlers.html#set_url_effect">url-open.modules.handlers.set_url_effect</a></li>
<li><a href="../modules/url-open.modules.autocmd.html#setup">url-open.modules.autocmd.setup</a></li>
<li><a href="../modules/url-open.html#Plugin.setup">url-open.setup</a></li>
</ul>


</dd>
<dt>
<a name = "setup"></a>
<strong>setup (user_opts)</strong>
Expand Down Expand Up @@ -120,7 +164,7 @@ <h3>See also:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-15 21:22:34 </i>
<i style="float:right;">Last updated 2023-09-16 11:05:12 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/url-open.modules.commands.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3>Usage:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-15 21:22:34 </i>
<i style="float:right;">Last updated 2023-09-16 11:05:12 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->

Expand Down
14 changes: 11 additions & 3 deletions docs/modules/url-open.modules.handlers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ <h2><a href="#Functions">Functions</a></h2>
If there is only one url in the line, then open it anywhere in the line.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_url_effect">set_url_effect ()</a></td>
<td class="name" nowrap><a href="#set_url_effect">set_url_effect (user_opts)</a></td>
<td class="summary">Add syntax matching rules for highlighting URLs/URIs.</td>
</tr>
</table>
Expand Down Expand Up @@ -225,12 +225,20 @@ <h3>Parameters:</h3>
</dd>
<dt>
<a name = "set_url_effect"></a>
<strong>set_url_effect ()</strong>
<strong>set_url_effect (user_opts)</strong>
</dt>
<dd>
Add syntax matching rules for highlighting URLs/URIs.


<h3>Parameters:</h3>
<ul>
<li><span class="parameter">user_opts</span>



</li>
</ul>



Expand All @@ -248,7 +256,7 @@ <h3>See also:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-15 21:22:34 </i>
<i style="float:right;">Last updated 2023-09-16 11:05:12 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/url-open.modules.logger.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ <h3>Parameters:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-15 21:22:34 </i>
<i style="float:right;">Last updated 2023-09-16 11:05:12 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/url-open.modules.options.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ <h3>Fields:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-15 21:22:34 </i>
<i style="float:right;">Last updated 2023-09-16 11:05:12 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/url-open.modules.patterns.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-15 21:22:34 </i>
<i style="float:right;">Last updated 2023-09-16 11:05:12 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->

Expand Down
2 changes: 1 addition & 1 deletion docs/topics/README.md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ <h2>License</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-09-15 21:22:34 </i>
<i style="float:right;">Last updated 2023-09-16 11:05:12 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->

Expand Down

0 comments on commit 39c18f0

Please sign in to comment.