diff --git a/doc/lualine.txt b/doc/lualine.txt index 1f11d04..40d2e9d 100644 --- a/doc/lualine.txt +++ b/doc/lualine.txt @@ -1,11 +1,12 @@ -lualine.txt *lualine-nvim* *lualine* +*lualine.txt* A blazing fast and easy to configure statusline + *lualine_nvim* *lualine* Author: hoob3rt (https://github.com/hoob3rt) License: MIT License Repository: https://github.com/hoob3rt/lualine.nvim =============================================================================== -LUALINE.NVIM *lualine-lualine.nvim* +LUALINE.NVIM *lualine_lualine.nvim* __ __ __ ______ __ __ __ __ ______ @@ -22,29 +23,29 @@ A blazing fast and easy to configure neovim statusline written in pure lua. `lualine.nvim` requires neovim 0.5 ================================================================================ -CONTENTS *lualline-contents* +CONTENTS *lualine_contents* -1. lualine.nvim...........................................|lualine-lualine.nvim| - 1.1. Performance comparism...................|lualine-performance_comparism| - 1.2. Installation.....................................|lualine-installation| - 1.2.1. vim-plug.......................................|lualine-vim-plug| - 1.2.2.packer.nvim..................................|lualine-packer.nvim| - 1.3. Usage and customization...............|lualine-usage_and_customization| - 1.3.1. Starting lualine.......................|lualine-starting_lualine| - 1.3.2. Setting theme.............................|lualine-setting_theme| - 1.3.3. Changing separator...................|lualine-changing_separator| - 1.3.4. Changing components.................|lualine-changing_components| - 1.3.5. Building Custom components............|lualine-custom_components| - 1.3.6. Custom options...........................|lualine-custom_options| - 1.3.7. Loading plugin extensions.....|lualine-loading_plugin_extensions| - 1.3.8 Config examples.........................|lualine-config_examples| - 1.3.8.1. Packer.nvim......|lualine-config_example_using_packer.nvim| - 1.3.8.2 VIML example.......|lualine-full_config_example_inside_viml| - 1.4. Contributing.....................................|lualine-contributing| - 1.5. Screenshots.......................................|lualine-screenshots| +1. lualine.nvim...........................................|lualine_lualine.nvim| + 1.1. Performance comparism...................|lualine_performance_comparism| + 1.2. Installation.....................................|lualine_installation| + 1.2.1. vim-plug.......................................|lualine_vim-plug| + 1.2.2.packer.nvim..................................|lualine_packer.nvim| + 1.3. Usage and customization...............|lualine_usage_and_customization| + 1.3.1. Starting lualine.......................|lualine_starting_lualine| + 1.3.2. Setting theme.............................|lualine_setting_theme| + 1.3.3. Changing separator...................|lualine_changing_separator| + 1.3.4. Changing components.................|lualine_changing_components| + 1.3.5. Building Custom components............|lualine_custom_components| + 1.3.6. Custom options...........................|lualine_custom_options| + 1.3.7. Loading plugin extensions.....|lualine_loading_plugin_extensions| + 1.3.8 Config examples.........................|lualine_config_examples| + 1.3.8.1. Packer.nvim......|lualine_config_example_using_packer.nvim| + 1.3.8.2 VIML example.......|lualine_full_config_example_inside_viml| + 1.4. Contributing.....................................|lualine_contributing| + 1.5. Screenshots.......................................|lualine_screenshots| ================================================================================ -PERFORMANCE COMPARISM *lualine-performance_comparism* +PERFORMANCE COMPARISM *lualine_performance_comparism* Unlike other statusline plugins lualine loads only defined components, nothing else. @@ -59,9 +60,9 @@ installed | 8.943 ms | 9.034 ms | 11.463 ms | 13.425 ms | -------------------------------------------------------------------------------- -INSTALLATION *lualine-installation* +INSTALLATION *lualine_installation* -VIM-PLUG *lualine-vim-plug* +VIM-PLUG *lualine_vim-plug* > Plug 'hoob3rt/lualine.nvim' " If you want to have icons in your statusline choose one of these @@ -69,7 +70,7 @@ VIM-PLUG *lualine-vim-plug* Plug 'ryanoasis/vim-devicons' < -PACKER.NVIM *lualine-packer.nvim* +PACKER.NVIM *lualine_packer.nvim* > use { 'hoob3rt/lualine.nvim', @@ -78,7 +79,7 @@ PACKER.NVIM *lualine-packer.nvim* < -------------------------------------------------------------------------------- -USAGE AND CUSTOMIZATION *lualine-usage_and_customization* +USAGE AND CUSTOMIZATION *lualine_usage_and_customization* Lualine has sections as shown below. > @@ -94,13 +95,13 @@ colorscheme as section `Z` etc. Configuration is currently limited to lua, please use lua block or a separate lua file to configure lualine. -STARTING LUALINE *lualine-starting_lualine* +STARTING LUALINE *lualine_starting_lualine* > local lualine = require('lualine') lualine.status() < -SETTING THEME *lualine-setting_theme* +SETTING THEME *lualine_setting_theme* > lualine.options.theme = 'gruvbox' < @@ -110,7 +111,7 @@ All available themes are listed in THEMES.md (./THEMES.md) Please create a pr if you managed to port a popular theme before me, here is how to do it (./CONTRIBUTING.md). -CHANGING SEPARATOR IN SECTION *lualine-changing_separator* +CHANGING SEPARATOR IN SECTION *lualine_changing_separator* Lualine defines a separator between components in given section, the default separator is `|`. You can change the separator this way: @@ -123,7 +124,7 @@ or disable it lualine.options.separator = '' < -CHANGING COMPONENTS IN LUALINE SECTIONS *lualine-changing_components* +CHANGING COMPONENTS IN LUALINE SECTIONS *lualine_changing_components* Lualine defaults~ @@ -165,7 +166,7 @@ Available components~ -------------------------------------------------------------------------------- -BUILDING YOUR COMPONENTS *lualine-custom_components* +BUILDING YOUR COMPONENTS *lualine_custom_components* Using custom functions as lualine component~ @@ -197,7 +198,7 @@ can be used. Scopes ending with o are options usualy accessed with `&` in vimscr < -------------------------------------------------------------------------------- -CUSTOM OPTIONS FOR COMPONENTS *lualine-custom_options* +CUSTOM OPTIONS FOR COMPONENTS *lualine_custom_options* Options for components~ @@ -320,7 +321,7 @@ Example:~ < -------------------------------------------------------------------------------- -LOADING PLUGIN EXTENSIONS *lualine-loading_plugin_extensions* +LOADING PLUGIN EXTENSIONS *lualine_loading_plugin_extensions* Lualine extensions change statusline appearance for a window/buffer with a plugin loaded e.g. junegunn/fzf.vim (https://github.com/junegunn/fzf.vim) @@ -334,9 +335,9 @@ using a plugin which is supported you can load it this way: All available extensions are listed in EXTENSIONS.md (./EXTENSIONS.md) -------------------------------------------------------------------------------- -CONGIG EXAMPLES *lualine-config_examples* +CONGIG EXAMPLES *lualine_config_examples* -FULL CONFIG EXAMPLE USING PACKER.NVIM *lualine-config_example_using_packer.nvim* +FULL CONFIG EXAMPLE USING PACKER.NVIM *lualine_config_example_using_packer.nvim* packer config @@ -375,7 +376,7 @@ packer config -------------------------------------------------------------------------------- -FULL CONFIG EXAMPLE INSIDE VIML *lualine-full_config_example_inside_viml* +FULL CONFIG EXAMPLE INSIDE VIML *lualine_full_config_example_inside_viml* vimrc config @@ -409,7 +410,7 @@ vimrc config < -------------------------------------------------------------------------------- -CONTRIBUTING *lualine-contributing* +CONTRIBUTING *lualine_contributing* Please read CONTRIBUTING.md (./CONTRIBUTING.md) before contributing. @@ -418,7 +419,7 @@ You can check this (https://github.com/hoob3rt/lualine.nvim/projects/3) out if y Feel free to create an issue/pr if you want to see anything else implemented. -------------------------------------------------------------------------------- -SCREENSHOTS *lualine-screenshots* +SCREENSHOTS *lualine_screenshots* Here is a preview of how lualine can look like. diff --git a/doc/tags b/doc/tags index 460e8d5..cfa3558 100644 --- a/doc/tags +++ b/doc/tags @@ -1,21 +1,22 @@ lualine lualine.txt /*lualine* -lualine-changing_components lualine.txt /*lualine-changing_components* -lualine-changing_separator lualine.txt /*lualine-changing_separator* -lualine-config_example_using_packer.nvim lualine.txt /*lualine-config_example_using_packer.nvim* -lualine-config_examples lualine.txt /*lualine-config_examples* -lualine-contributing lualine.txt /*lualine-contributing* -lualine-custom_components lualine.txt /*lualine-custom_components* -lualine-custom_options lualine.txt /*lualine-custom_options* -lualine-full_config_example_inside_viml lualine.txt /*lualine-full_config_example_inside_viml* -lualine-installation lualine.txt /*lualine-installation* -lualine-loading_plugin_extensions lualine.txt /*lualine-loading_plugin_extensions* -lualine-lualine.nvim lualine.txt /*lualine-lualine.nvim* -lualine-nvim lualine.txt /*lualine-nvim* -lualine-packer.nvim lualine.txt /*lualine-packer.nvim* -lualine-performance_comparism lualine.txt /*lualine-performance_comparism* -lualine-screenshots lualine.txt /*lualine-screenshots* -lualine-setting_a_theme lualine.txt /*lualine-setting_a_theme* -lualine-starting_lualine lualine.txt /*lualine-starting_lualine* -lualine-usage_and_customization lualine.txt /*lualine-usage_and_customization* -lualine-vim-plug lualine.txt /*lualine-vim-plug* -lualline-contents lualine.txt /*lualline-contents* +lualine.txt lualine.txt /*lualine.txt* +lualine_changing_components lualine.txt /*lualine_changing_components* +lualine_changing_separator lualine.txt /*lualine_changing_separator* +lualine_config_example_using_packer.nvim lualine.txt /*lualine_config_example_using_packer.nvim* +lualine_config_examples lualine.txt /*lualine_config_examples* +lualine_contents lualine.txt /*lualine_contents* +lualine_contributing lualine.txt /*lualine_contributing* +lualine_custom_components lualine.txt /*lualine_custom_components* +lualine_custom_options lualine.txt /*lualine_custom_options* +lualine_full_config_example_inside_viml lualine.txt /*lualine_full_config_example_inside_viml* +lualine_installation lualine.txt /*lualine_installation* +lualine_loading_plugin_extensions lualine.txt /*lualine_loading_plugin_extensions* +lualine_lualine.nvim lualine.txt /*lualine_lualine.nvim* +lualine_nvim lualine.txt /*lualine_nvim* +lualine_packer.nvim lualine.txt /*lualine_packer.nvim* +lualine_performance_comparism lualine.txt /*lualine_performance_comparism* +lualine_screenshots lualine.txt /*lualine_screenshots* +lualine_setting_theme lualine.txt /*lualine_setting_theme* +lualine_starting_lualine lualine.txt /*lualine_starting_lualine* +lualine_usage_and_customization lualine.txt /*lualine_usage_and_customization* +lualine_vim-plug lualine.txt /*lualine_vim-plug*