neovim-rose-pine/readme.md
2022-01-28 18:32:46 -06:00

6.1 KiB

Rosé Pine for Neovim

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

Usage

use({
    'rose-pine/neovim',
    as = 'rose-pine',
    tag = 'v0.1.0', -- Optional tag release
    config = function()
        vim.cmd('colorscheme rose-pine')
    end
})

Plugins

PR's are more than welcome if your favourite plugin is missing

require('lualine').setup({
	options = { theme = 'rose-pine' }
})
local colors = require("galaxyline.themes.colors")["rose-pine"]

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

-- Set theme variant
-- Matches terminal theme if unset
-- @usage 'main' | 'moon' | 'dawn'
vim.g.rose_pine_variant = ''

vim.g.rose_pine_bold_vertical_split_line = false
vim.g.rose_pine_inactive_background = false
vim.g.rose_pine_disable_background = false
vim.g.rose_pine_disable_float_background = false
vim.g.rose_pine_disable_italics = false

local p = require('rose-pine.palette')
vim.g.rose_pine_colors = {
	punctuation = p.subtle,
	comment = p.subtle,
	border = p.highlight_med,
	hint = p.iris,
	info = p.foam,
	warn = p.gold,
	error = p.love,

	-- Or set all headings to one colour: `headings = p.text`
	headings = {
		h1 = p.iris,
		h2 = p.foam,
		h3 = p.rose,
		h4 = p.gold,
		h5 = p.pine,
		h6 = p.foam,
	},
}

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

Functions

-- Toggle between all variants
require('rose-pine').toggle()

-- Toggle between some variants
require('rose-pine').toggle({'main', 'dawn'})

-- Set specific variant
require('rose-pine').set('moon')

Keymaps

These are only suggestions; no keymaps are set by the theme

-- Toggle variants
vim.api.nvim_set_keymap('n', '<c-m>', [[<cmd>lua require('rose-pine').toggle()<cr>]], { noremap = true, silent = true })

-- Set variant
vim.api.nvim_set_keymap('n', '<c-0>', [[<cmd>lua require('rose-pine').set('main')<cr>]], { noremap = true, silent = true })
vim.api.nvim_set_keymap('n', '<c-9>', [[<cmd>lua require('rose-pine').set('moon')<cr>]], { noremap = true, silent = true })
vim.api.nvim_set_keymap('n', '<c-8>', [[<cmd>lua require('rose-pine').set('dawn')<cr>]], { noremap = true, silent = true })

Contributing

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