mirror of
https://github.com/rose-pine/neovim.git
synced 2025-10-15 12:38:53 +02:00
feat!: spring cleaning
This commit is contained in:
mvllow
parent
92762f4fa2
commit
7de6b77b76
19 changed files with 1067 additions and 963 deletions
142
readme.md
142
readme.md
|
|
@ -11,30 +11,20 @@
|
|||
</a>
|
||||
</p>
|
||||
|
||||
## Install
|
||||
## Getting started
|
||||
|
||||
**[Paq](https://github.com/savq/paq-nvim)**
|
||||
Install `rose-pine/neovim` using your favourite plugin manager:
|
||||
|
||||
**paq-nvim**
|
||||
|
||||
```lua
|
||||
require('paq')({
|
||||
{ 'rose-pine/neovim', as = 'rose-pine' }
|
||||
})
|
||||
{ 'rose-pine/neovim', as = 'rose-pine' }
|
||||
```
|
||||
|
||||
**[lazy.nvim](https://github.com/folke/lazy.nvim)**
|
||||
**lazy.nvim**
|
||||
|
||||
```lua
|
||||
require("lazy").setup({
|
||||
{ 'rose-pine/neovim', name = 'rose-pine' }
|
||||
})
|
||||
```
|
||||
|
||||
**[packer.nvim](https://github.com/wbthomason/packer.nvim)**
|
||||
|
||||
```lua
|
||||
require('packer').startup(function(use)
|
||||
use({ 'rose-pine/neovim', as = 'rose-pine' })
|
||||
end)
|
||||
{ 'rose-pine/neovim', name = 'rose-pine' }
|
||||
```
|
||||
|
||||
## Gallery
|
||||
|
|
@ -53,75 +43,85 @@ end)
|
|||
|
||||
## Options
|
||||
|
||||
> [!NOTE]
|
||||
> Options should be set **before** colorscheme
|
||||
> [!IMPORTANT]
|
||||
> Configure options _before_ setting colorscheme.
|
||||
|
||||
Variant respects `vim.o.background`, using dawn when light and `dark_variant` when dark
|
||||
Rosé Pine has three variants: main, moon, and dawn. By default, `vim.o.background` is followed, using dawn when light and `dark_variant` when dark.
|
||||
|
||||
Colour values accept named colours from the [Rosé Pine palette](https://rosepinetheme.com/palette/ingredients/), e.g. "foam", or valid hex, e.g. "#fa8072".
|
||||
|
||||
```lua
|
||||
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,
|
||||
variant = "auto", -- auto, main, moon, or dawn
|
||||
dark_variant = "main", -- main, moon, or dawn
|
||||
dim_inactive_windows = false,
|
||||
extend_background_behind_borders = 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',
|
||||
styles = {
|
||||
bold = true,
|
||||
italic = true,
|
||||
transparency = false,
|
||||
},
|
||||
|
||||
error = 'love',
|
||||
hint = 'iris',
|
||||
info = 'foam',
|
||||
warn = 'gold',
|
||||
groups = {
|
||||
border = "muted",
|
||||
link = "iris",
|
||||
panel = "surface",
|
||||
|
||||
headings = {
|
||||
h1 = 'iris',
|
||||
h2 = 'foam',
|
||||
h3 = 'rose',
|
||||
h4 = 'gold',
|
||||
h5 = 'pine',
|
||||
h6 = 'foam',
|
||||
}
|
||||
-- or set all headings at once
|
||||
-- headings = 'subtle'
|
||||
},
|
||||
error = "love",
|
||||
hint = "iris",
|
||||
info = "foam",
|
||||
warn = "gold",
|
||||
|
||||
-- Change specific vim highlight groups
|
||||
-- https://github.com/rose-pine/neovim/wiki/Recipes
|
||||
highlight_groups = {
|
||||
ColorColumn = { bg = 'rose' },
|
||||
git_add = "foam",
|
||||
git_change = "rose",
|
||||
git_delete = "love",
|
||||
git_dirty = "rose",
|
||||
git_ignore = "muted",
|
||||
git_merge = "iris",
|
||||
git_rename = "pine",
|
||||
git_stage = "iris",
|
||||
git_text = "rose",
|
||||
git_untracked = "subtle",
|
||||
|
||||
-- Blend colours against the "base" background
|
||||
CursorLine = { bg = 'foam', blend = 10 },
|
||||
StatusLine = { fg = 'love', bg = 'love', blend = 10 },
|
||||
headings = {
|
||||
h1 = "iris",
|
||||
h2 = "foam",
|
||||
h3 = "rose",
|
||||
h4 = "gold",
|
||||
h5 = "pine",
|
||||
h6 = "foam",
|
||||
},
|
||||
-- Alternatively, set all headings at once.
|
||||
-- headings = "subtle",
|
||||
},
|
||||
|
||||
-- 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 },
|
||||
}
|
||||
highlight_groups = {
|
||||
-- Comment = { fg = "foam" }
|
||||
-- VertSplit = { fg = "muted", bg = "muted" }
|
||||
},
|
||||
|
||||
before_highlight = function(group, highlight, palette)
|
||||
-- Disable all undercurls.
|
||||
-- if highlight.undercurl then
|
||||
-- highlight.undercurl = false
|
||||
-- end
|
||||
--
|
||||
-- Change palette colour.
|
||||
-- if highlight.fg == palette.pine then
|
||||
-- highlight.fg = palette.foam
|
||||
-- end
|
||||
end,
|
||||
})
|
||||
|
||||
-- Set colorscheme after options
|
||||
vim.cmd('colorscheme rose-pine')
|
||||
-- vim.cmd('colorscheme rose-pine-main')
|
||||
-- vim.cmd('colorscheme rose-pine-moon')
|
||||
-- vim.cmd('colorscheme rose-pine-dawn')
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome and appreciate any help in creating a lovely experience for all.
|
||||
We welcome and appreciate contributions of any kind. Create an issue or start a discussion for any proposed changes. Pull requests are encouraged for supporting additional plugins.
|
||||
|
||||
- Get highlight groups under cursor via `:Inspect` in Neovim 0.9 or [nvim-treesitter/playground](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)
|
||||
- [Palette reference by name](https://rosepinetheme.com/palette)
|
||||
Feel free to update the [wiki](https://github.com/rose-pine/neovim/wiki/) with any [recipes](https://github.com/rose-pine/neovim/wiki/Recipes).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue