neovim-rose-pine/readme.md
Wenderson Barros e81165e84e
docs: linking the project wiki in the readme for easy access to information about plugins
As suggested in the PR, I linked the repository wiki which already contained information about lualine and other plugins
2023-12-24 20:30:24 -04:00

5.8 KiB

Rosé Pine for Neovim

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

Install

Paq

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

lazy.nvim

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

packer.nvim

require('packer').startup(function(use)
  use({ 'rose-pine/neovim', as = 'rose-pine' })
end)

Rosé Pine

Rosé Pine with Neovim

Rosé Pine Moon

Rosé Pine Moon with Neovim

Rosé Pine Dawn

Rosé Pine Dawn with Neovim

Options

Note

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'
	},

	-- 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 },

		-- By default each group adds to the existing config.
		-- If you only want to set what is written in this config exactly,
		-- you can set the inherit option:
		Search = { bg = 'gold', inherit = false },
	}
})

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

Note

For more information on customizing certain plugins such as Lualine, Bufferline, and toggleterm, please visit the Rose Pine Wiki.

Contributing

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