From 547a45bbf5bf57c088f6f77924d503f95de1561a Mon Sep 17 00:00:00 2001 From: Meow Honk <21010072+catgoose@users.noreply.github.com> Date: Tue, 19 Nov 2024 07:24:35 -0600 Subject: [PATCH] doc: updates readme, adds notes (#100) --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1cffcb4..267d97c 100644 --- a/README.md +++ b/README.md @@ -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() @@ -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 @@ -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({