Merge branch 'dev-doc' into dev

dev-doc
Pocco81 3 years ago
commit 76a2485c4d

@ -130,7 +130,7 @@ NeoBundleFetch 'Pocco81/Catppuccino.nvim'
There are already some sane defaults that you may like, however you can change them to match your taste. These are the defaults: There are already some sane defaults that you may like, however you can change them to match your taste. These are the defaults:
```lua ```lua
colorscheme = "catppuccino", colorscheme = "dark_catppuccino",
transparency = false, transparency = false,
styles = { styles = {
comments = "italic", comments = "italic",
@ -183,7 +183,7 @@ local catppuccino = require("catppuccino")
-- configure it -- configure it
catppuccino.setup( catppuccino.setup(
{ {
colorscheme = "catppuccino", colorscheme = "dark_catppuccino",
transparency = false, transparency = false,
styles = { styles = {
comments = "italic", comments = "italic",
@ -224,9 +224,6 @@ catppuccino.setup(
} }
} }
) )
-- load it
catppuccino.load()
``` ```
<br /> <br />
@ -243,7 +240,7 @@ local catppuccino = require("catppuccino")
-- configure it -- configure it
catppuccino.setup( catppuccino.setup(
{ {
colorscheme = "catppuccino", colorscheme = "dark_catppuccino",
transparency = false, transparency = false,
styles = { styles = {
comments = "italic", comments = "italic",
@ -284,15 +281,26 @@ catppuccino.setup(
} }
} }
) )
-- load it
catppuccino.load()
EOF EOF
``` ```
<br /> <br />
</details> </details>
After setting things up, you can load Catppuccino like so:
For Lua:
```lua
catppuccino.load(<colorscheme_name>)
```
If `<colorscheme_name>` is not passed then it'll pick the one in the config.
For VimScript:
```lua
colorscheme catppuccino
```
Passing `catppuccino` to the `colorscheme` command will pick the colorscheme in the config. Optionally, you could pass one by its code name (e.g. `colorscheme neon_latte`).
For instructions on how to configure the plugin, check out the [configuration](#configuration) section. For instructions on how to configure the plugin, check out the [configuration](#configuration) section.
## Updating ## Updating

Loading…
Cancel
Save