github/neovim-rose-pine
1
0
Fork 0
mirror of https://github.com/rose-pine/neovim.git synced 2025-10-15 12:38:53 +02:00
Code Issues Projects Releases Packages Wiki Activity
neovim-rose-pine/readme.md
Niamh Ferns 76cae45b4e
 feat!: custom user highlight groups are merged with Rosé Pine defaults (#171) 
Configuring `highlight_groups` now merge by default. For example, to add italics without changing the colour:

```diff
- Keyword = { fg = "pine", italic = true }
+ Keyword = { italic = true }
```

Opt out of this behaviour via `inherit = false`.
2023-07-15 17:04:58 +02:00

5.4 KiB
Raw Blame History

Rosé Pine for Neovim

All natural pine, faux fur and a bit of soho vibes for the classy minimalist

Usage

With lazy.nvim

require("lazy").setup({
	{ 'rose-pine/neovim', name = 'rose-pine' }
})

vim.cmd('colorscheme rose-pine')

With packer.nvim

use({ 'rose-pine/neovim', as = 'rose-pine' })

vim.cmd('colorscheme rose-pine')

Supported plugins are listed in the wiki

Gallery

Rosé Pine

Rosé Pine with Neovim

Rosé Pine Moon

Rosé Pine Moon with Neovim

Rosé Pine Dawn

Rosé Pine Dawn with Neovim

Options

Options should be set before colorscheme

Variant respects vim.o.background, using dawn when light and dark_variant when dark

require('rose-pine').setup({
	--- @usage 'auto'|'main'|'moon'|'dawn'
	variant = 'auto',
	--- @usage 'main'|'moon'|'dawn'
	dark_variant = 'main',
	bold_vert_split = false,
	dim_nc_background = false,
	disable_background = false,
	disable_float_background = false,
	disable_italics = false,

	--- @usage string hex value or named color from rosepinetheme.com/palette
	groups = {
		background = 'base',
		background_nc = '_experimental_nc',
		panel = 'surface',
		panel_nc = 'base',
		border = 'highlight_med',
		comment = 'muted',
		link = 'iris',
		punctuation = 'subtle',

		error = 'love',
		hint = 'iris',
		info = 'foam',
		warn = 'gold',

		headings = {
			h1 = 'iris',
			h2 = 'foam',
			h3 = 'rose',
			h4 = 'gold',
			h5 = 'pine',
			h6 = 'foam',
		}
		-- or set all headings at once
		-- headings = 'subtle'
	},

	-- Whether or not highlight_groups optios should change only only update
	-- the settings they touch or should reset the entire highlight_group.
	respect_default_highlight_groups = true,

	-- Change specific vim highlight groups
	-- https://github.com/rose-pine/neovim/wiki/Recipes
	highlight_groups = {
		ColorColumn = { bg = 'rose' },

		-- Blend colours against the "base" background
		CursorLine = { bg = 'foam', blend = 10 },
		StatusLine = { fg = 'love', bg = 'love', blend = 10 },
	}
})

-- Set colorscheme after options
vim.cmd('colorscheme rose-pine')

Contributing

We welcome and appreciate any help in creating a lovely experience for all.