mirror of
https://github.com/rose-pine/neovim.git
synced 2025-10-15 12:38:53 +02:00
e103407675* Remove the option, which is not longer implemented * Add an example for the inherit highlight config
122 lines
5.5 KiB
Markdown
122 lines
5.5 KiB
Markdown
<p align="center">
|
|
<img src="https://github.com/rose-pine/rose-pine-theme/raw/main/assets/icon.png" width="80" />
|
|
<h2 align="center">Rosé Pine for Neovim</h2>
|
|
</p>
|
|
|
|
<p align="center">All natural pine, faux fur and a bit of soho vibes for the classy minimalist</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/rose-pine/rose-pine-theme">
|
|
<img src="https://img.shields.io/badge/community-rosé%20pine-26233a?labelColor=191724&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjUwIiBoZWlnaHQ9IjIzNyIgdmlld0JveD0iMCAwIDI1MCAyMzciIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CjxwYXRoIGQ9Ik0xNjEuMjI3IDE2MS4yNTFDMTMyLjE1NCAxNjkuMDQxIDExNC45MDEgMTk4LjkyNCAxMjIuNjkxIDIyNy45OTdDMTIzLjkyNSAyMzIuNjAzIDEyOC42NTkgMjM1LjMzNiAxMzMuMjY0IDIzNC4xMDJMMTg1LjkwNyAyMTkuOTk2QzIxOS41ODUgMjEwLjk3MiAyMzkuNTcgMTc2LjM1NCAyMzAuNTQ2IDE0Mi42NzdMMTYxLjIyNyAxNjEuMjUxWiIgZmlsbD0iIzI0NjI3QiIvPgo8cGF0aCBkPSJNODguMTgzNiAxNTkuOTg4QzExNy4yNTcgMTY3Ljc3OCAxMzQuNTEgMTk3LjY2MiAxMjYuNzIgMjI2LjczNUMxMjUuNDg2IDIzMS4zNCAxMjAuNzUyIDIzNC4wNzMgMTE2LjE0NyAyMzIuODM5TDYzLjUwNDEgMjE4LjczM0MyOS44MjY0IDIwOS43MSA5Ljg0MDk0IDE3NS4wOTIgMTguODY0OSAxNDEuNDE0TDg4LjE4MzYgMTU5Ljk4OFoiIGZpbGw9IiMyNDYyN0IiLz4KPHBhdGggZD0iTTE4Ni44NjcgMTcyLjk4QzE1Mi4wMDIgMTcyLjk4IDEyMy43MzcgMjAxLjI0NSAxMjMuNzM3IDIzNi4xMTFIMTg2Ljg3QzIyMS43MzYgMjM2LjExMSAyNTAgMjA3Ljg0NiAyNTAgMTcyLjk4TDE4Ni44NjcgMTcyLjk4WiIgZmlsbD0iIzMxNzQ4RiIvPgo8cGF0aCBkPSJNNjMuMTMyNyAxNzIuOThDOTcuOTk4NCAxNzIuOTggMTI2LjI2MyAyMDEuMjQ1IDEyNi4yNjMgMjM2LjExMUg2My4xM0MyOC4yNjQyIDIzNi4xMTEgLTEuNTI0MDNlLTA2IDIwNy44NDYgMCAxNzIuOThMNjMuMTMyNyAxNzIuOThaIiBmaWxsPSIjMzE3NDhGIi8+CjxwYXRoIGQ9Ik0xNzEuNzE3IDc1LjEyNjNDMTcxLjcxNyAxMDEuMjc2IDE1MC41MTggMTIyLjQ3NSAxMjQuMzY5IDEyMi40NzVDOTguMjE4OCAxMjIuNDc1IDc3LjAyMDIgMTAxLjI3NiA3Ny4wMjAyIDc1LjEyNjNDNzcuMDIwMiA0OC45NzY0IDk4LjIxODggMjcuNzc3OCAxMjQuMzY5IDI3Ljc3NzhDMTUwLjUxOCAyNy43Nzc4IDE3MS43MTcgNDguOTc2NCAxNzEuNzE3IDc1LjEyNjNaIiBmaWxsPSIjRUJCQ0JBIi8+CjxwYXRoIGQ9Ik0xNDQuMjE3IDg2LjIzNzlDMTYxLjY0OSA1Ni4wNDMyIDE1MS4zMDMgMTcuNDMyOSAxMjEuMTA4IDBMMTA2LjA2IDI2LjA2NDRDODguNjI3IDU2LjI1OSA5OC45NzM2IDk0Ljg2OTQgMTI5LjE2OCAxMTIuMzAyTDE0NC4yMTcgODYuMjM3OVoiIGZpbGw9IiNFQkJDQkEiLz4KPHBhdGggZD0iTTEyNS4yOTkgNjAuOTc4OUMxMTYuMjc1IDI3LjMwMTIgODEuNjU3NSA3LjMxNTY3IDQ3Ljk3OTcgMTYuMzM5Nkw2NC4zMTk3IDc3LjMyMTFDNzMuMzQzNiAxMTAuOTk5IDEwNy45NjEgMTMwLjk4NCAxNDEuNjM5IDEyMS45NkwxMjUuMjk5IDYwLjk3ODlaIiBmaWxsPSIjRUJCQ0JBIi8+CjxwYXRoIGQ9Ik0xMjQuOTI2IDYwLjk3ODlDMTMzLjk1IDI3LjMwMTIgMTY4LjU2NyA3LjMxNTY3IDIwMi4yNDUgMTYuMzM5NkwxODUuOTA1IDc3LjMyMTFDMTc2Ljg4MSAxMTAuOTk5IDE0Mi4yNjMgMTMwLjk4NCAxMDguNTg2IDEyMS45NkwxMjQuOTI2IDYwLjk3ODlaIiBmaWxsPSIjRUJCQ0JBIi8+Cjwvc3ZnPgo=&style=for-the-badge" />
|
|
</a>
|
|
</p>
|
|
|
|
## Usage
|
|
|
|
> With [lazy.nvim](https://github.com/folke/lazy.nvim)
|
|
|
|
```lua
|
|
require("lazy").setup({
|
|
{ 'rose-pine/neovim', name = 'rose-pine' }
|
|
})
|
|
|
|
vim.cmd('colorscheme rose-pine')
|
|
```
|
|
|
|
> With [packer.nvim](https://github.com/wbthomason/packer.nvim)
|
|
|
|
```lua
|
|
use({ 'rose-pine/neovim', as = 'rose-pine' })
|
|
|
|
vim.cmd('colorscheme rose-pine')
|
|
```
|
|
|
|
_Supported plugins are listed in the [wiki](https://github.com/rose-pine/neovim/wiki#supported-plugins)_
|
|
|
|
## Gallery
|
|
|
|
**Rosé Pine**
|
|
|
|
|
|
|
|
**Rosé Pine Moon**
|
|
|
|
|
|
|
|
**Rosé Pine Dawn**
|
|
|
|
|
|
|
|
## Options
|
|
|
|
> Options should be set **before** colorscheme
|
|
|
|
Variant respects `vim.o.background`, using dawn when light and `dark_variant` when dark
|
|
|
|
```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,
|
|
|
|
--- @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')
|
|
```
|
|
|
|
## Contributing
|
|
|
|
We welcome and appreciate any help in creating a lovely experience for all.
|
|
|
|
- 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)
|