Module texcat.renderer
a class to render
Info:
- Copyright: 2025
Functions
| get_path (filename) | get path of template https://github.com/nvim-neorocks/lux/issues/922 |
| get_output (format, args) | get output in format |
| split (str) | split by "\n" |
| add_scope (color_map, captures) | add child scopes to color map |
| get_hls (text, captures) | get highlights |
| escape_tex (text, prefix) | escape TeX, protect \, {, } |
| escape (text, prefix, math_escape) | escape TeX with math escape |
Class Renderer
| M.Renderer:new (renderer) | |
| M.Renderer:get_opts (text, format, opts) | get options |
| M.Renderer:render (text, format, opts) | render a text |
| M.Renderer:render_file (filename, format, opts) | render a file |
Functions
- get_path (filename)
-
get path of template
https://github.com/nvim-neorocks/lux/issues/922
Parameters:
- filename string template name
Returns:
-
string file template path
- get_output (format, args)
-
get output in format
Parameters:
- format string
- args table
Returns:
-
string text
- split (str)
-
split by "\n"
Parameters:
- str string
Returns:
-
string[] tokens
- add_scope (color_map, captures)
-
add child scopes to color map
Parameters:
- color_map color_map
- captures capture[]
- get_hls (text, captures)
-
get highlights
Parameters:
- text string
- captures capture[]
Returns:
-
hl[] hls
- escape_tex (text, prefix)
-
escape TeX, protect
\,{,}Parameters:
- text string
- prefix string
Returns:
-
string text
- escape (text, prefix, math_escape)
-
escape TeX with math escape
Parameters:
- text string
- prefix string
- math_escape boolean
Returns:
-
string text
Class Renderer
- M.Renderer:new (renderer)
-
Parameters:
- renderer table?
Returns:
-
table renderer
- M.Renderer:get_opts (text, format, opts)
-
get options
Parameters:
- text string
- format string
- opts
table
Returns:
-
table
- M.Renderer:render (text, format, opts)
-
render a text
Parameters:
- text string
- format string
- opts
table
Returns:
-
string
- M.Renderer:render_file (filename, format, opts)
-
render a file
Parameters:
- filename string
- format string
- opts
table
Returns:
-
string