diff --git a/doc/tokyonight.txt b/doc/tokyonight.txt index 6d227b9..e4d70ed 100644 --- a/doc/tokyonight.txt +++ b/doc/tokyonight.txt @@ -12,6 +12,7 @@ Table of Contents *tokyonight-table-of-contents* - 📦 Installation |tokyonight-📦-installation| - 🚀 Usage |tokyonight-🚀-usage| - ⚙️ Configuration |tokyonight-⚙️-configuration| + - 🪓 Overriding Colors & Highlight Groups|tokyonight-🪓-overriding-colors-&-highlight-groups| - 🍭 Extras |tokyonight-🍭-extras| - 🔥 Contributing |tokyonight-🔥-contributing| @@ -205,6 +206,21 @@ TokyoNight will use the default options, unless you call `setup`. < +🪓 OVERRIDING COLORS & HIGHLIGHT GROUPS*tokyonight-🪓-overriding-colors-&-highlight-groups* + +How the highlight groups are calculated: + + +1. the **colors** for the style are calculated based on your config +2. `config.on_colors(colors)` is ran, where you can override the colors +3. the **colors** are then used to generate the highlight groups +4. `config.on_highlights(highlights, colors)` is ran, where you can overide the highlight groups + + +Please refer to default values for `colors` and `highlights` for the storm +, night , day + + Example for changing some settings and colors > @@ -213,7 +229,7 @@ Example for changing some settings and colors style = "night", -- disable italic for functions styles = { - functions = "NONE" + functions = {} }, sidebars = { "qf", "vista_kind", "terminal", "packer" }, -- Change the "hint" color to the "orange" color, and make the "error" color bright red