Skip to content

Commit

Permalink
chore(build): auto-generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Nov 11, 2024
1 parent dda3097 commit a869ef7
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ of some basic window properties like the border and the maximum height of the
window. It also has a field to define the character used for the scrollbar.

## Type Icons
`config.ui.type_icons? care.config.ui.type_icons`
`config.ui.type_icons? care.config.ui.type_icons|string`

This is a table which defines the different icons.

Expand Down
38 changes: 38 additions & 0 deletions docs/configuration_recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,44 @@ end
vim.fn.setreg("+", table.concat(documentation, "\n"))
```

## Integrations for icons

There are various integrations with different plugins for icons in care.nvim

### Mini.icons

Install mini.icons as described in
[the readme](https://github.com/echasnovski/mini.icons/tree/main). (Don't forget
to call `require"mini.icons".setup()`!).

Then use the following configuration for care.

```lua
require("care").setup({
ui = {
type_icons = "mini.icons"
}
})
```

Mini.icons also allows you to use ascii icons by using `{ style = "ascii" }` in
the setup.

### Lspkind.nvim

Install lspkind.nvim as described in
[the readme](https://github.com/onsails/lspkind.nvim/tree/master).

Then use the following configuration for care.

```lua
require("care").setup({
ui = {
type_icons = "lspkind"
}
})
```

## Manual completion like builtin neovim

You can use filters to only complete certain sources. This can be used to create
Expand Down

0 comments on commit a869ef7

Please sign in to comment.