docs: be explicit about creating highlight groups

olimorris · Jun 18, 2023 · 8133c24 · 8133c24
1 parent 455dfbe
commit 8133c24
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -314,6 +314,30 @@ require("onedarkpro").setup({
 })
 ```
 
+**Creating highlight groups**
+
+You can also create your own highlight groups:
+
+```lua
+require("onedarkpro").setup({
+  highlights = {
+    MyNewHighlightGroup = { fg = "${red}" }
+  }
+})
+```
+
+or, if you'd like to disable certain highlight groups:
+
+```lua
+require("onedarkpro").setup({
+  highlights = {
+    "[@lsp.type.comment]" = {}
+  }
+})
+```
+
+> **Note**: This can be useful to prevent LSP servers from applying groups with semantic highlights
+
 **Specifying highlight attributes by theme or background**
 
 As with colors, highlight attributes may be specified by using the theme name or the background color. For example:

diff --git a/doc/onedarkpro.nvim.txt b/doc/onedarkpro.nvim.txt
@@ -332,6 +332,31 @@ or _override_ them:
     })
 <
 
+**Creating highlight groups**
+
+You can also create your own highlight groups:
+
+>lua
+    require("onedarkpro").setup({
+      highlights = {
+        MyNewHighlightGroup = { fg = "${red}" }
+      }
+    })
+<
+
+or, if you’d like to disable certain highlight groups:
+
+>lua
+    require("onedarkpro").setup({
+      highlights = {
+        "[@lsp.type.comment]" = {}
+      }
+    })
+<
+
+
+  **Note**This can be useful to prevent LSP servers from applying groups with
+  semantic highlights
 **Specifying highlight attributes by theme or background**
 
 As with colors, highlight attributes may be specified by using the theme name