From fd8fa5ddd823e15721ddec560ea61e7372e746a7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 7 Jan 2022 21:54:10 +0600 Subject: [PATCH] chore: generated vimdoc (#539) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- doc/lualine.txt | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/doc/lualine.txt b/doc/lualine.txt index c584100..7380c09 100644 --- a/doc/lualine.txt +++ b/doc/lualine.txt @@ -82,13 +82,10 @@ Lualine has sections as shown below. Each sections holds its components e.g. Vim’s current mode. - *lualine-Configuring-lualine-in-init.vim* - -Configuring lualine in init.vim All the examples below are in lua. You - can use the same examples in `.vim` - files by wrapping them in lua heredoc - like this: +CONFIGURING LUALINE IN INIT.VIM ~ +All the examples below are in lua. You can use the same examples in `.vim` +files by wrapping them in lua heredoc like this: > lua << END @@ -195,6 +192,9 @@ lualine defines two kinds of separators: - `components_separators` - separators between the different components in sections +**Note**: if viewing this README in a browser, chances are the characters below +will not be visible. + > options = { section_separators = { left = '', right = '' }, @@ -297,8 +297,12 @@ global variables - require statements COMPONENT OPTIONS ~ Component options can change the way a component behave. There are two kinds of -options: - global options affecting all components - local options affecting -specific +options: + + +- global options affecting all components +- local options affecting specific + Global options can be used as local options (can be applied to specific components) but you cannot use local options as global. Global option used @@ -330,7 +334,7 @@ Global options These are `options` that are used in Values set here are treated as default for other options that work in component level. -for example even though `icons_enabled` is a general component option. you can +For example even though `icons_enabled` is a general component option. you can set `icons_enabled` to `false` and icons will be disabled on all component. You can still overwrite defaults set in option table by specifying the option value in component.