Skip to content

Commit

Permalink
docs: auto generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@sgoudham @github-actions
sgoudham authored and github-actions[bot] committed Oct 20, 2024
1 parent c2647ac commit 2b1ed64
Showing 1 changed file with 60 additions and 87 deletions.
147 changes: 60 additions & 87 deletions doc/catppuccin.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,26 @@
==============================================================================
Table of Contents *catppuccin-table-of-contents*

1. Features |catppuccin-features|
2. Installation |catppuccin-installation|
3. Usage |catppuccin-usage|
4. Configuration |catppuccin-configuration|
5. Customize highlights |catppuccin-customize-highlights|
- Get catppuccin colors|catppuccin-customize-highlights-get-catppuccin-colors|
- Overwriting colors |catppuccin-customize-highlights-overwriting-colors|
- Overwriting highlight groups|catppuccin-customize-highlights-overwriting-highlight-groups|
6. Integrations |catppuccin-integrations|
7. Compile |catppuccin-compile|
8. FAQ |catppuccin-faq|
- Wrong treesitter highlights |catppuccin-faq-wrong-treesitter-highlights|
- Colors doesn’t match preview screenshots|catppuccin-faq-colors-doesn’t-match-preview-screenshots|
9. Thanks to |catppuccin-thanks-to|
10. Links |catppuccin-links|

==============================================================================
1. Features *catppuccin-features*

- Supports both vim and neovim (Requires neovim <https://github.com/neovim/neovim/> >= 0.8 or vim <https://github.com/vim/vim> >= 9 compiled with lua <https://github.com/lua/lua> >= 5.1)
- Highly configurable with 4 different flavours and ability to create your own! <https://github.com/catppuccin/nvim/discussions/323>
- Compile <https://github.com/catppuccin/nvim#Compile> user config for fastest startuptime <https://www.reddit.com/r/neovim/comments/xxfpt3/catppuccinnvim_now_startup_in_1ms/>
- Features |catppuccin-features|
- Installation |catppuccin-installation|
- Usage |catppuccin-usage|
- Configuration |catppuccin-configuration|
- Customization |catppuccin-customization|
- Integrations |catppuccin-integrations|
- Compile |catppuccin-compile|
- 🙋 FAQ |catppuccin-🙋-faq|
- 💝 Thanks to |catppuccin-💝-thanks-to|

FEATURES *catppuccin-features*

- Supports both Vim and Neovim (requires neovim <https://github.com/neovim/neovim/> >= 0.8 or vim <https://github.com/vim/vim> >= 9 compiled with lua <https://github.com/lua/lua> >= 5.1)
- Highly configurable with 4 different flavours and the ability to create your own! <https://github.com/catppuccin/nvim/discussions/323>
- Compiled <https://github.com/catppuccin/nvim#Compile> configuration for fast startup time <https://www.reddit.com/r/neovim/comments/xxfpt3/catppuccinnvim_now_startup_in_1ms/>
- Integrations with lsp, treesitter and a bunch of plugins <https://github.com/catppuccin/nvim#integrations>
- Supports for many other applications <https://github.com/catppuccin/catppuccin>
- Support for many other applications <https://github.com/catppuccin/catppuccin>


==============================================================================
2. Installation *catppuccin-installation*
INSTALLATION *catppuccin-installation*

lazy.nvim <https://github.com/folke/lazy.nvim>

Expand All @@ -51,8 +43,7 @@ vim-plug <https://github.com/junegunn/vim-plug>
<


==============================================================================
3. Usage *catppuccin-usage*
USAGE *catppuccin-usage*

>vim
colorscheme catppuccin " catppuccin-latte, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha
Expand All @@ -63,8 +54,7 @@ vim-plug <https://github.com/junegunn/vim-plug>
<


==============================================================================
4. Configuration *catppuccin-configuration*
CONFIGURATION *catppuccin-configuration*

There is no need to call `setup` if you don’t want to change the default
options and settings.
Expand Down Expand Up @@ -124,11 +114,10 @@ options and settings.
<


==============================================================================
5. Customize highlights *catppuccin-customize-highlights*
CUSTOMIZATION *catppuccin-customization*


GET CATPPUCCIN COLORS *catppuccin-customize-highlights-get-catppuccin-colors*
GETTING COLORS ~

>lua
local latte = require("catppuccin.palettes").get_palette "latte"
Expand All @@ -137,14 +126,14 @@ GET CATPPUCCIN COLORS *catppuccin-customize-highlights-get-catppuccin-colors*
local mocha = require("catppuccin.palettes").get_palette "mocha"
<

Returns a table where the key is the name of the color and the value is its hex
value corresponding to each flavour.
Returns a table where the key is the name of the color and the value is the hex
code.


OVERWRITING COLORS *catppuccin-customize-highlights-overwriting-colors*
OVERWRITING COLORS ~

Colors can be overwritten using `color_overrides` in the setting, checkout
https://github.com/catppuccin/nvim/discussions/323 for inspirations:
Colors can be overwritten using `color_overrides`, see
https://github.com/catppuccin/nvim/discussions/323 for inspiration:

>lua
require("catppuccin").setup {
Expand All @@ -165,12 +154,9 @@ https://github.com/catppuccin/nvim/discussions/323 for inspirations:
<


[!Note] For more information check out our style-guide
<https://github.com/catppuccin/catppuccin/blob/main/docs/style-guide.md>

OVERWRITING HIGHLIGHT GROUPS*catppuccin-customize-highlights-overwriting-highlight-groups*
OVERWRITING HIGHLIGHT GROUPS ~

Global highlight groups can be overwritten in the setting, for example:
Global highlight groups can be overwritten, for example:

>lua
require("catppuccin").setup {
Expand All @@ -185,8 +171,7 @@ Global highlight groups can be overwritten in the setting, for example:
}
<

Per flavour highlight groups can also be overwritten in the setting, for
example:
Highlight groups per flavour can also be overwritten, for example:

>lua
require("catppuccin").setup {
Expand Down Expand Up @@ -222,8 +207,7 @@ example:
<


==============================================================================
6. Integrations *catppuccin-integrations*
INTEGRATIONS *catppuccin-integrations*

Catppuccin provides theme support for other plugins in the Neovim ecosystem and
extended Neovim functionality through _integrations_.
Expand Down Expand Up @@ -256,13 +240,14 @@ Some integrations are enabled by default, you can control this behaviour with
})
<

Below is a list of supported plugins and their corresponding integration
Below are a list of supported plugins and their corresponding integration
module.


[!Important] If you’d like to know which highlight groups are being affected
by catppuccin, check out this directory: `lua/catppuccin/groups/integrations/`
<https://github.com/catppuccin/nvim/tree/main/lua/catppuccin/groups/integrations>.
[!Important] If you’d like to see the full list of highlight groups modified
by Catppuccin, see the `lua/catppuccin/groups/integrations/`
<https://github.com/catppuccin/nvim/tree/main/lua/catppuccin/groups/integrations>
directory.
PluginDefaultaerial.nvim>lua
aerial = false
<
Expand Down Expand Up @@ -303,7 +288,7 @@ bufferline.nvimSpecial ~
Update your bufferline config to use the Catppuccin components:


[!NOTE] bufferline needs to be loaded after setting up catppuccin or it will
[!NOTE] bufferline needs to be loaded after setting up Catppuccin or it will
highlight incorrectly
>lua
use "akinsho/bufferline.nvim" {
Expand Down Expand Up @@ -354,7 +339,7 @@ Setting `enabled` to `true` enables this integration.

[!Note] coc.nvim by default link to native lsp highlight groups so config from
`native_lsp` will also apply to coc
In the inners tables you can set the style for the diagnostics, both
In the nested tables you can set the style for the diagnostics, both
`virtual_text` (what you see on the side) and `underlines` (what points
directly at the thing (e.g. an error)).

Expand Down Expand Up @@ -873,19 +858,15 @@ which-key.nvim>lua
<


==============================================================================
7. Compile *catppuccin-compile*

COMPILE *catppuccin-compile*

**Important** As of 7/10/2022, catppuccin should be able to automatically
recompile when the setup table changed.
Catppuccin is a highly customizable and configurable colorscheme. This does
however come at the cost of complexity and execution time. Catppuccin can pre
compute the results of your configuration and store the results in a compiled
lua file. We use these precached values to set it’s highlights.
Lua file. We use these pre-cached values to set it’s highlights.

By default catppuccin writes the compiled results into the system’s cache
directory. You can change the cache dir using:
By default, Catppuccin writes the compiled results into the system’s cache
directory. See below if you’d like to change the cache directory:

>lua
require("catppuccin").setup({ -- Note: On windows we replace `/` with `\` by default
Expand All @@ -894,13 +875,12 @@ directory. You can change the cache dir using:
<


==============================================================================
8. FAQ *catppuccin-faq*
🙋 FAQ *catppuccin-🙋-faq*


WRONG TREESITTER HIGHLIGHTS *catppuccin-faq-wrong-treesitter-highlights*
WHY DO MY TREESITTER HIGHLIGHTS LOOK INCORRECT? ~

Please disable `additional_vim_regex_highlighting`
Please disable `additional_vim_regex_highlighting`:

>lua
require("nvim-treesitter.configs").setup {
Expand All @@ -912,40 +892,33 @@ Please disable `additional_vim_regex_highlighting`
<


COLORS DOESN’T MATCH PREVIEW SCREENSHOTS*catppuccin-faq-colors-doesn’t-match-preview-screenshots*

Catppuccin requires true color support AKA terminals support the full range of
16 million colors

- Supported: iterm2 (macOS), kitty, wezterm, alacritty, tmux, …
WHY AREN’T MY COLORS THE SAME AS THE PREVIEWS? ~

Full list of support terminals can be found here:
<https://github.com/termstandard/colors#truecolor-support-in-output-devices>
Catppuccin requires that your terminal supports true color, meaning that your
terminal can display the full range of 16 million colors.

- Unsupported terminal: Terminal.app (macOS), Terminus, Terminology, …
- Supported: iterm2 (macOS), kitty, wezterm, alacritty, see full list… <https://github.com/termstandard/colors#truecolor-support-in-output-devices>
- Unsupported: Terminal.app (macOS), Terminus, Terminology, see full list… <https://github.com/termstandard/colors#not-supporting-truecolor>

Full list of Unsupported terminals can be found here:
<https://github.com/termstandard/colors#not-supporting-truecolor>
If you use tmux, make sure to enable true color support
<https://gist.github.com/andersevenrud/015e61af2fd264371032763d4ed965b6> and
italic font support
<https://gist.github.com/gyribeiro/4192af1aced7a1b555df06bd3781a722>. This will
prevent issues raised in #415 <https://github.com/catppuccin/nvim/issues/415>
and #428 <https://github.com/catppuccin/nvim/issues/428>.


FOR TMUX USERS ~
💝 THANKS TO *catppuccin-💝-thanks-to*

- Enable true color support <https://gist.github.com/andersevenrud/015e61af2fd264371032763d4ed965b6> to fix the following abnormal colors <https://github.com/catppuccin/nvim/issues/415>:
**Current Maintainer(s)**

- Enable italic font support <https://gist.github.com/gyribeiro/4192af1aced7a1b555df06bd3781a722> to fix the following incorrect if, then, else, end highlights <https://github.com/catppuccin/nvim/issues/428>:
- vollowx <https://github.com/vollowx>


==============================================================================
9. Thanks to *catppuccin-thanks-to*
**Previous Maintainer(s)**

- Pocco81 <https://github.com/Pocco81>
- nullchilly <https://github.com/nullchilly>

==============================================================================
10. Links *catppuccin-links*

1. *image*: https://user-images.githubusercontent.com/1941785/220280749-c3ab52fb-9b8a-4f04-ab98-f8c1bb41f84b.png
2. *image*: https://user-images.githubusercontent.com/13246770/224011118-dcf0f567-650a-4eb2-8be6-0af5cf435501.png
- mrtnvgr <https://github.com/mrtnvgr>

Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

Expand Down

0 comments on commit 2b1ed64

Please sign in to comment.