Skip to content

Commit

Permalink
Adds instructions to see YAML info in the statusline
Browse files Browse the repository at this point in the history
Thanks for the inspiration, @joshzcold :)
  • Loading branch information
cuducos committed Oct 31, 2023
1 parent 3f57cae commit b1fd34f
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ Plug 'cuducos/yaml.nvim'

## Configuration

### Showing the YAML patch and value in Neovim's winbar
### Showing the YAML path and value

#### Neovim's winbar

```lua
vim.api.nvim_create_autocmd({ "FileType" }, {
Expand All @@ -80,6 +82,18 @@ vim.api.nvim_create_autocmd({ "FileType" }, {
})
```

#### Neovim's statusline (with [`lualine.nvim`](https://github.com/nvim-lualine/lualine.nvim))

```lua
require("lualine").setup({
sections = {
lualine_x = { require("yaml_nvim").get_yaml_key_and_value },
-- etc
}
})

```

## Reporting bugs and contributing

There is a mini toolchain to help you test the plugin in isolation using a container. It requires:
Expand Down

0 comments on commit b1fd34f

Please sign in to comment.