Auto generate docs

This commit is contained in:
akinsho 2022-04-06 12:27:07 +00:00 committed by GitHub Actions
parent d0e8c4da31
commit f4637c80b4

View file

@ -118,6 +118,20 @@ the terminals will be discarded when closed.
on_exit = fun(t: Terminal, job: number, exit_code: number, name: string) -- function to run when terminal process exits
hide_numbers = true, -- hide the number column in toggleterm buffers
shade_filetypes = {},
highlights = {
-- highlights which map to a highlight group name and a table of it's values
-- NOTE: this is only a subset of values, any group placed here will be set for the terminal window split
Normal = {
guibg = <VALUE-HERE>,
},
NormalFloat = {
guibg = <VALUE-HERE>,
},
FloatBorder = {
guifg = <VALUE-HERE>,
guibg = <VALUE-HERE>,
},
},
shade_terminals = true,
shading_factor = '<number>', -- the degree by which to darken to terminal colour, default: 1 for dark backgrounds, 3 for light
start_in_insert = true,
@ -137,10 +151,6 @@ the terminals will be discarded when closed.
width = <value>,
height = <value>,
winblend = 3,
highlights = {
border = "Normal",
background = "Normal",
}
}
}
<
@ -309,6 +319,7 @@ Each terminal can take the following arguments:
direction = string -- the layout for the terminal, same as the main config options
dir = string -- the directory for the terminal
close_on_exit = bool -- close the terminal window when the process exits
highlights = table -- a table with highlights
on_open = fun(t: Terminal) -- function to run when the terminal opens
on_close = fun(t: Terminal) -- function to run when the terminal closes
-- callbacks for processing the output
@ -358,6 +369,14 @@ You can also set a custom layout for a terminal.
local lazygit = Terminal:new({
cmd = "lazygit",
dir = "git_dir",
highlights = {
NormalFloat = {
guibg = '#000000'
},
FloatBorder = {
guifg = '#fffff'
}
},
direction = "float",
float_opts = {
border = "double",