aboutsummaryrefslogtreecommitdiff
path: root/doc/modules
diff options
context:
space:
mode:
Diffstat (limited to 'doc/modules')
-rw-r--r--doc/modules/colorizer.buffer_utils.html26
-rw-r--r--doc/modules/colorizer.color_utils.html9
-rw-r--r--doc/modules/colorizer.html109
-rw-r--r--doc/modules/colorizer.matcher_utils.html2
-rw-r--r--doc/modules/colorizer.trie.html2
-rw-r--r--doc/modules/utils.html2
6 files changed, 121 insertions, 29 deletions
diff --git a/doc/modules/colorizer.buffer_utils.html b/doc/modules/colorizer.buffer_utils.html
index f2f75fe..142164c 100644
--- a/doc/modules/colorizer.buffer_utils.html
+++ b/doc/modules/colorizer.buffer_utils.html
@@ -62,11 +62,11 @@
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
- <td class="name" nowrap><a href="#highlight_buffer">highlight_buffer (buf, ns, lines, line_start, options)</a></td>
+ <td class="name" nowrap><a href="#highlight_buffer">highlight_buffer (buf, ns, lines, line_start, options, options_local)</a></td>
<td class="summary">Highlight the buffer region.</td>
</tr>
<tr>
- <td class="name" nowrap><a href="#rehighlight_buffer">rehighlight_buffer (buf, options)</a></td>
+ <td class="name" nowrap><a href="#rehighlight_buffer">rehighlight_buffer (buf, options, options_local)</a></td>
<td class="summary">Rehighlight the buffer if colorizer is active</td>
</tr>
</table>
@@ -94,7 +94,7 @@
<dl class="function">
<dt>
<a name = "highlight_buffer"></a>
- <strong>highlight_buffer (buf, ns, lines, line_start, options)</strong>
+ <strong>highlight_buffer (buf, ns, lines, line_start, options, options_local)</strong>
</dt>
<dd>
Highlight the buffer region.
@@ -119,8 +119,16 @@
<li><span class="parameter">options</span>
table: Configuration options as described in <code>setup</code>
</li>
+ <li><span class="parameter">options_local</span>
+ table: Buffer local variables
+ </li>
</ul>
+ <h3>Returns:</h3>
+ <ol>
+
+ nil|boolean|number,function|nil
+ </ol>
@@ -128,7 +136,7 @@
</dd>
<dt>
<a name = "rehighlight_buffer"></a>
- <strong>rehighlight_buffer (buf, options)</strong>
+ <strong>rehighlight_buffer (buf, options, options_local)</strong>
</dt>
<dd>
Rehighlight the buffer if colorizer is active
@@ -142,8 +150,16 @@
<li><span class="parameter">options</span>
table: Buffer options
</li>
+ <li><span class="parameter">options_local</span>
+ table|nil: Buffer local variables
+ </li>
</ul>
+ <h3>Returns:</h3>
+ <ol>
+
+ nil|boolean|number,function|nil
+ </ol>
@@ -215,7 +231,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-09-03 17:24:13 </i>
+<i style="float:right;">Last updated 2022-09-06 15:06:04 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
diff --git a/doc/modules/colorizer.color_utils.html b/doc/modules/colorizer.color_utils.html
index 613185c..8cd68e2 100644
--- a/doc/modules/colorizer.color_utils.html
+++ b/doc/modules/colorizer.color_utils.html
@@ -64,7 +64,7 @@
<td class="summary">Determine whether to use black or white text.</td>
</tr>
<tr>
- <td class="name" nowrap><a href="#color_name_parser">color_name_parser (line, i)</a></td>
+ <td class="name" nowrap><a href="#color_name_parser">color_name_parser (line, i, opts)</a></td>
<td class="summary">Grab all the colour values from <code>vim.api.nvim_get_color_map</code> and create a lookup table.</td>
</tr>
<tr>
@@ -131,7 +131,7 @@
</dd>
<dt>
<a name = "color_name_parser"></a>
- <strong>color_name_parser (line, i)</strong>
+ <strong>color_name_parser (line, i, opts)</strong>
</dt>
<dd>
Grab all the colour values from <code>vim.api.nvim_get_color_map</code> and create a lookup table.
@@ -146,6 +146,9 @@
<li><span class="parameter">i</span>
number: Index of line from where to start parsing
</li>
+ <li><span class="parameter">opts</span>
+ table: Currently contains whether tailwind is enabled or not
+ </li>
</ul>
@@ -348,7 +351,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-09-03 17:24:13 </i>
+<i style="float:right;">Last updated 2022-09-06 15:06:04 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
diff --git a/doc/modules/colorizer.html b/doc/modules/colorizer.html
index 3db15a7..e02633c 100644
--- a/doc/modules/colorizer.html
+++ b/doc/modules/colorizer.html
@@ -33,6 +33,7 @@
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
+<li><a href="#Tables">Tables</a></li>
<li><a href="#Fields">Fields</a></li>
</ul>
@@ -155,6 +156,13 @@ USE WITH LUA
<td class="summary">Clear the highlight cache and reload all buffers.</td>
</tr>
</table>
+<h2><a href="#Tables">Tables</a></h2>
+<table class="function_list">
+ <tr>
+ <td class="name" nowrap><a href="#user_default_options">user_default_options</a></td>
+ <td class="summary">defaults options.</td>
+ </tr>
+</table>
<h2><a href="#Fields">Fields</a></h2>
<table class="function_list">
<tr>
@@ -271,8 +279,7 @@ USE WITH LUA
<strong>setup (config)</strong>
</dt>
<dd>
-
-<p>Easy to use function if you want the full setup without fine grained control.
+ Easy to use function if you want the full setup without fine grained control.
Setup an autocmd which enables colorizing for the filetypes and options specified.</p>
<p>By default highlights all FileTypes.</p>
@@ -288,26 +295,13 @@ Setup an autocmd which enables colorizing for the filetypes and options specifie
<pre>
require("colorizer").setup {
filetypes = { "*" },
- user_default_options = {
- RGB = true, -- #RGB hex codes
- RRGGBB = true, -- #RRGGBB hex codes
- names = true, -- "Name" codes like Blue or blue
- RRGGBBAA = false, -- #RRGGBBAA hex codes
- AARRGGBB = false, -- 0xAARRGGBB hex codes
- rgb_fn = false, -- CSS rgb() and rgba() functions
- hsl_fn = false, -- CSS hsl() and hsla() functions
- css = false, -- Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB
- css_fn = false, -- Enable all CSS *functions*: rgb_fn, hsl_fn
- -- Available modes for <code>mode</code>: foreground, background, virtualtext
- mode = "background", -- Set the display mode.
- virtualtext = "■",
- },
+ user_default_options,
-- all the sub-options of filetypes apply to buftypes
buftypes = {},
}
</pre>
-
+<p>For all user<em>default</em>options, see |user<em>default</em>options|
<h3>Parameters:</h3>
@@ -375,6 +369,85 @@ Setup an autocmd which enables colorizing for the filetypes and options specifie
</dd>
</dl>
+ <h2 class="section-header "><a name="Tables"></a>Tables</h2>
+
+ <dl class="function">
+ <dt>
+ <a name = "user_default_options"></a>
+ <strong>user_default_options</strong>
+ </dt>
+ <dd>
+
+<p>defaults options. </p>
+
+<pre>
+ user_default_options = {
+ RGB = true, -- #RGB hex codes
+ RRGGBB = true, -- #RRGGBB hex codes
+ names = true, -- "Name" codes like Blue or blue
+ RRGGBBAA = false, -- #RRGGBBAA hex codes
+ AARRGGBB = false, -- 0xAARRGGBB hex codes
+ rgb_fn = false, -- CSS rgb() and rgba() functions
+ hsl_fn = false, -- CSS hsl() and hsla() functions
+ css = false, -- Enable all CSS features: rgb_fn, hsl_fn, names, RGB, RRGGBB
+ css_fn = false, -- Enable all CSS *functions*: rgb_fn, hsl_fn
+ -- Available modes for <code>mode</code>: foreground, background, virtualtext
+ mode = "background", -- Set the display mode.
+ -- Available methods are false / "normal" / "lsp" / "both"
+ tailwind = false -- Enable tailwind colors
+ virtualtext = "■",
+ }
+</pre>
+
+
+
+
+ <h3>Fields:</h3>
+ <ul>
+ <li><span class="parameter">RGB</span>
+ boolean
+ </li>
+ <li><span class="parameter">RRGGBB</span>
+ boolean
+ </li>
+ <li><span class="parameter">names</span>
+ boolean
+ </li>
+ <li><span class="parameter">RRGGBBAA</span>
+ boolean
+ </li>
+ <li><span class="parameter">AARRGGBB</span>
+ boolean
+ </li>
+ <li><span class="parameter">rgb_fn</span>
+ boolean
+ </li>
+ <li><span class="parameter">hsl_fn</span>
+ boolean
+ </li>
+ <li><span class="parameter">css</span>
+ boolean
+ </li>
+ <li><span class="parameter">css_fn</span>
+ boolean
+ </li>
+ <li><span class="parameter">mode</span>
+ string
+ </li>
+ <li><span class="parameter">tailwind</span>
+ boolean|string
+ </li>
+ <li><span class="parameter">virtualtext</span>
+ string
+ </li>
+ </ul>
+
+
+
+
+
+</dd>
+</dl>
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
<dl class="function">
@@ -404,7 +477,7 @@ Setup an autocmd which enables colorizing for the filetypes and options specifie
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-09-03 17:24:13 </i>
+<i style="float:right;">Last updated 2022-09-06 15:06:04 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
diff --git a/doc/modules/colorizer.matcher_utils.html b/doc/modules/colorizer.matcher_utils.html
index e709932..e4cccee 100644
--- a/doc/modules/colorizer.matcher_utils.html
+++ b/doc/modules/colorizer.matcher_utils.html
@@ -106,7 +106,7 @@ Do not try make the function again if it is present in the cache
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-09-03 17:24:13 </i>
+<i style="float:right;">Last updated 2022-09-06 15:06:04 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
diff --git a/doc/modules/colorizer.trie.html b/doc/modules/colorizer.trie.html
index 0261786..e2c7192 100644
--- a/doc/modules/colorizer.trie.html
+++ b/doc/modules/colorizer.trie.html
@@ -62,7 +62,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-09-03 17:24:13 </i>
+<i style="float:right;">Last updated 2022-09-06 15:06:04 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
diff --git a/doc/modules/utils.html b/doc/modules/utils.html
index 3e3ff4d..ffe7615 100644
--- a/doc/modules/utils.html
+++ b/doc/modules/utils.html
@@ -224,7 +224,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2022-09-03 17:24:13 </i>
+<i style="float:right;">Last updated 2022-09-06 15:06:04 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
By 🦊 with love. ❤