Skip to content

Commit

Permalink
doc: updates readme, adds notes (norcalli#100)
Browse files Browse the repository at this point in the history
  • Loading branch information
catgoose authored Nov 19, 2024
1 parent 5d32edf commit 547a45b
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ use("NvChad/nvim-colorizer.lua")
One line setup. This will create an `autocmd` for `FileType *` to highlight
every filetype.

**NOTE**: You should add this line after/below where your plugins are setup.
> [!NOTE]
> You should add this line after/below where your plugins are setup.
```lua
require("colorizer").setup()
Expand All @@ -76,6 +77,9 @@ require("colorizer").setup()
| **ColorizerReloadAllBuffers** | Reload all buffers that are being highlighted currently |
| **ColorizerToggle** | Toggle highlighting of the current buffer |

> [!NOTE]
> User commands can be enabled/disabled in setup opts
### Lua API

```lua
Expand Down Expand Up @@ -112,7 +116,8 @@ library to do custom highlighting themselves.

## Customization

**Note**: These are the default options
> [!NOTE]
> These are the default options
```lua
require("colorizer").setup({
Expand Down

0 comments on commit 547a45b

Please sign in to comment.