doc: introduce lua-heredoc for configuring through viml
This commit is contained in:
parent
cdc574c9b0
commit
d8b960fc34
15
README.md
15
README.md
|
@ -106,6 +106,21 @@ Lualine has sections as shown below.
|
||||||
|
|
||||||
Each sections holds it's components e.g. current vim's mode.
|
Each sections holds it's components e.g. current vim's mode.
|
||||||
|
|
||||||
|
<details><summary>Configuring from `.vim` file</summary>
|
||||||
|
|
||||||
|
All the examples below are in lua. You can use the same examples
|
||||||
|
in `.vim` file by wrapping them in lua heredoc like this:
|
||||||
|
|
||||||
|
```vim
|
||||||
|
lua << END
|
||||||
|
require'lualine'.setup()
|
||||||
|
END
|
||||||
|
```
|
||||||
|
|
||||||
|
checkout `:help lua-heredoc`.
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
<details><summary>Default config</summary>
|
<details><summary>Default config</summary>
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
|
|
|
@ -82,6 +82,20 @@ Lualine has sections as shown below.
|
||||||
|
|
||||||
Each sections holds it’s components e.g. current vim’s mode.
|
Each sections holds it’s components e.g. current vim’s mode.
|
||||||
|
|
||||||
|
Configuring from `.vim` file
|
||||||
|
|
||||||
|
All the examples below are in lua. You can use the same examples in `.vim` file
|
||||||
|
by wrapping them in lua heredoc like this:
|
||||||
|
|
||||||
|
>
|
||||||
|
lua << END
|
||||||
|
require'lualine'.setup()
|
||||||
|
END
|
||||||
|
<
|
||||||
|
|
||||||
|
|
||||||
|
checkout `:help lua-heredoc`.
|
||||||
|
|
||||||
Default config
|
Default config
|
||||||
|
|
||||||
>
|
>
|
||||||
|
|
Loading…
Reference in New Issue