rob
/
lualine.nvim
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix README.md (#466) 

fix some errors of indentation in the README.md file
This commit is contained in:
joao-vitor-sr 2021-12-05 23:09:43 -03:00 committed by GitHub
parent 1ae4f0aa74
commit 1a888a1ed3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
README.md
View File

@ -61,7 +61,7 @@ And measured time is complete startuptime of vim not time spent
on specific plugin. These numbers are average of 20 runs. on specific plugin. These numbers are average of 20 runs.
| control | lualine | lightline | airline | | control | lualine | lightline | airline |
| :--------: | :-------: | :-------: | :-------: | | :------: | :-------: | :-------: | :-------: |
| 8.943 ms | 10.140 ms | 12.522 ms | 38.850 ms | | 8.943 ms | 10.140 ms | 12.522 ms | 38.850 ms |
Last Updated On: 20-09-2021 Last Updated On: 20-09-2021
@ -112,7 +112,6 @@ END
checkout `:help lua-heredoc`. checkout `:help lua-heredoc`.
#### Default config #### Default config
```lua ```lua
@ -147,7 +146,6 @@ require'lualine'.setup {
} }
``` ```
If you want to get your current lualine config. you can If you want to get your current lualine config. you can
do so with do so with
@ -190,15 +188,14 @@ require'lualine'.setup{
Theme structure is available [here](./CONTRIBUTING.md#adding-a-theme) Theme structure is available [here](./CONTRIBUTING.md#adding-a-theme)
--- ---
### Separators ### Separators
Lualine defines two kinds of separators: Lualine defines two kinds of separators:
* `section_separators` - separators between sections - `section_separators` - separators between sections
* `components_separators` - separators between components in sections - `components_separators` - separators between components in sections
```lua ```lua
options = { options = {
@ -216,7 +213,6 @@ it'll be used for right sections (x, y, z).
options = {section_separators = '', component_separators = ''} options = {section_separators = '', component_separators = ''}
``` ```
--- ---
### Changing components in lualine sections ### Changing components in lualine sections
@ -227,21 +223,20 @@ sections = {lualine_a = {'mode'}}
#### Available components #### Available components
* `branch` (git branch) - `branch` (git branch)
* `buffers` (shows currently available buffers) - `buffers` (shows currently available buffers)
* `diagnostics` (diagnostics count from your prefered source) - `diagnostics` (diagnostics count from your prefered source)
* `diff` (git diff status) - `diff` (git diff status)
* `encoding` (file encoding) - `encoding` (file encoding)
* `fileformat` (file format) - `fileformat` (file format)
* `filename` - `filename`
* `filesize` - `filesize`
* `filetype` - `filetype`
* `hostname` - `hostname`
* `location` (location in file in line:column format) - `location` (location in file in line:column format)
* `mode` (vim mode) - `mode` (vim mode)
* `progress` (%progress in file) - `progress` (%progress in file)
* `tabs` (shows currently available tabs) - `tabs` (shows currently available tabs)
#### Custom components #### Custom components
@ -279,9 +274,11 @@ sections = {lualine_a = {'g:coc_status', 'bo:filetype'}}
##### Lua expressions as lualine component ##### Lua expressions as lualine component
You can use any valid lua expression as a component including You can use any valid lua expression as a component including
* oneliners
* global variables - oneliners
* require statements - global variables
- require statements
```lua ```lua
sections = {lualine_c = {"os.date('%a')", 'data', "require'lsp-status'.status()"}} sections = {lualine_c = {"os.date('%a')", 'data', "require'lsp-status'.status()"}}
``` ```
@ -294,8 +291,9 @@ sections = {lualine_c = {"os.date('%a')", 'data', "require'lsp-status'.status()"
Component options can change the way a component behave. Component options can change the way a component behave.
There are two kinds of options: There are two kinds of options:
* global options affecting all components
* local options affecting specific - global options affecting all components
- local options affecting specific
Global options can be used as local options (can be applied to specific components) Global options can be used as local options (can be applied to specific components)
but you cannot use local options as global. but you cannot use local options as global.
@ -390,7 +388,6 @@ sections = {
} }
``` ```
#### Component specific options #### Component specific options
These are options that are available on specific components. These are options that are available on specific components.
@ -405,7 +402,7 @@ sections = {
{ {
'buffers', 'buffers',
show_filename_only = true, -- shows shortened relative path when false show_filename_only = true, -- shows shortened relative path when false
show_modified_status = true -- shows indicator then buffer is modified show_modified_status = true, -- shows indicator then buffer is modified
mode = 0, -- 0 shows buffer name mode = 0, -- 0 shows buffer name
-- 1 buffer index (bufnr) -- 1 buffer index (bufnr)
-- 2 shows buffer name + buffer index (bufnr) -- 2 shows buffer name + buffer index (bufnr)
@ -552,7 +549,6 @@ sections = {
} }
``` ```
--- ---
### Tabline ### Tabline
@ -622,16 +618,15 @@ extensions = {'quickfix'}
#### Available extensions #### Available extensions
* chadtree - chadtree
* fern - fern
* fugitive - fugitive
* fzf - fzf
* nerdtree - nerdtree
* nvim-tree - nvim-tree
* quickfix - quickfix
* toggleterm - toggleterm
* symbols-outline - symbols-outline
#### Custom extensions #### Custom extensions
@ -655,6 +650,7 @@ options = {disabled_filetypes = {'lua'}}
<!-- panvimdoc-ignore-start --> <!-- panvimdoc-ignore-start -->
### Contributors ### Contributors
Thanks to these wonderful people we enjoy this awesome plugin. Thanks to these wonderful people we enjoy this awesome plugin.
<a href="https://github.com/nvim-lualine/lualine.nvim/graphs/contributors"> <a href="https://github.com/nvim-lualine/lualine.nvim/graphs/contributors">
@ -662,10 +658,12 @@ Thanks to these wonderful people we enjoy this awesome plugin.
</a> </a>
### Wiki ### Wiki
Check out the [wiki](https://github.com/nvim-lualine/lualine.nvim/wiki) for more info . Check out the [wiki](https://github.com/nvim-lualine/lualine.nvim/wiki) for more info .
You can find some useful [configuration snippets](https://github.com/nvim-lualine/lualine.nvim/wiki/Component-snippets) here. You can also share your awesome snippents with others. You can find some useful [configuration snippets](https://github.com/nvim-lualine/lualine.nvim/wiki/Component-snippets) here. You can also share your awesome snippents with others.
If you want to extened lualine with plugins or want to know If you want to extened lualine with plugins or want to know
which ones already do [wiki/plugins](https://github.com/nvim-lualine/lualine.nvim/wiki/Plugins) is for you. which ones already do [wiki/plugins](https://github.com/nvim-lualine/lualine.nvim/wiki/Plugins) is for you.
<!-- panvimdoc-ignore-end --> <!-- panvimdoc-ignore-end -->