Rosé Pine for Neovim
All natural pine, faux fur and a bit of soho vibes for the classy minimalist
## Usage
```lua
use({
'rose-pine/neovim',
as = 'rose-pine',
config = function()
-- Options (see available options below)
vim.g.rose_pine_variant = 'base'
-- Load colorscheme after options
vim.cmd('colorscheme rose-pine')
end
})
```
## Plugins
> PR's are more than welcome if your favourite plugin is missing
- **[Treesitter](https://github.com/nvim-treesitter/nvim-treesitter)**
- **[Diagnostics](https://neovim.io/doc/user/lsp.html)**
- **[Barbar](https://github.com/romgrk/barbar.nvim)**
- **[Gitsigns](https://github.com/lewis6991/gitsigns.nvim)**
- **[Modes](https://github.com/mvllow/modes.nvim)**
- **[NvimTree](https://github.com/kyazdani42/nvim-tree.lua)**
- **[WhichKey](https://github.com/folke/which-key.nvim)**
- **[Indent-Blankline.nvim](https://github.com/lukas-reineke/indent-blankline.nvim)**
- **[Neogit](https://github.com/TimUntersberger/neogit)**
- **[Lualine](https://github.com/hoob3rt/lualine.nvim)**
```lua
require('lualine').setup({
options = { theme = 'rose-pine' }
})
```
- **[Galaxyline fork](https://github.com/NTBBloodbath/galaxyline.nvim)**
> This fork by NTBBloodbath allows [custom colors](https://github.com/NTBBloodbath/galaxyline.nvim/blob/main/docs/themes.md#colors-standards)
```lua
-- Set colors in your galaxyline config
local colors = require("galaxyline.themes.colors")["rose-pine"]
```
## Gallery
**Rosé Pine**
**Rosé Pine Moon**
**Rosé Pine Dawn**
## Options
> Options should be set before colorscheme
### Interface
```lua
-- Set variant
-- Defaults to 'dawn' if vim background is light
-- @usage 'base' | 'moon' | 'dawn' | 'rose-pine[-moon][-dawn]'
vim.g.rose_pine_variant = 'base'
-- Disable italics
vim.g.rose_pine_disable_italics = false
-- Use terminal background
vim.g.rose_pine_disable_background = false
-- Use bold vertical split line
vim.g.rose_pine_bold_vertical_split_line = true
```
### Custom colours
```lua
vim.g.rose_pine_colors = {
punctuation = '#fa8072',
comment = '#ffffff',
hint = '#9745be',
info = '#78ccc5',
warn = '#f5c359',
error = '#c75c6a',
headings = {
h1 = '#999999',
h2 = '#888888',
h3 = '#777777',
h4 = '#666666',
h5 = '#555555',
}
}
```
Be sure to set the colorscheme _after_ options
```lua
-- Set colorscheme after options
vim.cmd('colorscheme rose-pine')
```
## Functions
```lua
-- Toggle between the three variants
require('rose-pine.functions').toggle_variant()
-- Toggle between base and dawn
require('rose-pine.functions').toggle_variant({'base', 'dawn'})
-- Switch to specified variant
require('rose-pine.functions').select_variant('moon')
```
## Keymaps
```lua
-- Toggle variant
vim.api.nvim_set_keymap('n', '', [[lua require('rose-pine.functions').toggle_variant()]], { noremap = true, silent = true })
-- Select each variant
vim.api.nvim_set_keymap('n', '', [[lua require('rose-pine.functions').select_variant('dawn')]], { noremap = true, silent = true })
vim.api.nvim_set_keymap('n', '', [[lua require('rose-pine.functions').select_variant('moon')]], { noremap = true, silent = true })
vim.api.nvim_set_keymap('n', '', [[lua require('rose-pine.functions').select_variant('base')]], { noremap = true, silent = true })
```
## Contributing
We welcome and appreciate any help in creating a lovely experience for all.
- [Get highlight groups under cursor](https://github.com/nvim-treesitter/playground#show-treesitter-and-syntax-highlight-groups-under-the-cursor)
- [Adding new highlight groups](https://github.com/rose-pine/neovim/issues/6#issuecomment-962466323)