mirror of
https://github.com/rose-pine/neovim.git
synced 2025-10-15 12:38:53 +02:00
110 lines
5 KiB
Markdown
110 lines
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>
|
|
|
|
## Install
|
|
|
|
Install via your preferred package manager
|
|
|
|
```lua
|
|
-- Packer
|
|
use({ 'rose-pine/neovim', as = 'rose-pine' })
|
|
```
|
|
|
|
## Usage
|
|
|
|
Enable `rose-pine` colorscheme
|
|
|
|
```lua
|
|
vim.cmd('colorscheme rose-pine')
|
|
```
|
|
|
|
Enable [lualine](https://github.com/hoob3rt/lualine.nvim) plugin
|
|
|
|
```lua
|
|
require('lualine').setup({
|
|
options = {
|
|
theme = 'rose-pine'
|
|
}
|
|
})
|
|
```
|
|
|
|
## Plugin Support
|
|
|
|
- [Treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
|
|
- [LSP diagnostics](https://neovim.io/doc/user/lsp.html)
|
|
- [Barbar](https://github.com/romgrk/barbar.nvim)
|
|
- [Gitsigns](https://github.com/lewis6991/gitsigns.nvim)
|
|
- [Modes](https://github.com/mvllow/modes.nvim)
|
|
- [NvimTree](https://github.com/kyazdani42/nvim-tree.lua)
|
|
- [WhichKey](https://github.com/folke/which-key.nvim)
|
|
- [Todo Comments](https://github.com/folke/todo-comments.nvim)
|
|
- [Lualine](https://github.com/hoob3rt/lualine.nvim)
|
|
|
|
## Gallery
|
|
|
|
**Rosé Pine**
|
|
|
|
|
|
|
|
**Rosé Pine Moon**
|
|
|
|
|
|
|
|
**Rosé Pine Dawn**
|
|
|
|
|
|
|
|
## Options
|
|
|
|
> Options should be set before the colorscheme
|
|
|
|
```lua
|
|
-- Set variant
|
|
-- @usage 'base' | 'moon' | 'dawn' | 'rose-pine[-moon][-dawn]'
|
|
vim.g.rose_pine_variant = 'base'
|
|
|
|
-- Enable italics
|
|
vim.g.rose_pine_enable_italics = true
|
|
|
|
-- Use terminal background
|
|
-- Note: Set to true to fix any funky background colors
|
|
vim.g.rose_pine_disable_background = false
|
|
|
|
-- Set colorscheme after options
|
|
vim.cmd('colorscheme rose-pine')
|
|
```
|
|
|
|
## Functions
|
|
|
|
```lua
|
|
-- Toggle between the three variants
|
|
require('rose-pine.functions').toggle_variant()
|
|
|
|
-- Toggle between base and dawn
|
|
require('rose-pine.functions').toggle_variant({'base', 'dawn'})
|
|
|
|
-- Switch to specified variant
|
|
require('rose-pine.functions').select_variant('moon')
|
|
```
|
|
|
|
## Keymaps
|
|
|
|
```lua
|
|
-- Toggle variant
|
|
vim.api.nvim_set_keymap('n', '<c-m>', [[<cmd>lua require('rose-pine.functions').toggle_variant()<cr>]], { noremap = true, silent = true })
|
|
|
|
-- Select each variant
|
|
vim.api.nvim_set_keymap('n', '<c-8>', [[<cmd>lua require('rose-pine.functions').select_variant('dawn')<cr>]], { noremap = true, silent = true })
|
|
vim.api.nvim_set_keymap('n', '<c-9>', [[<cmd>lua require('rose-pine.functions').select_variant('moon')<cr>]], { noremap = true, silent = true })
|
|
vim.api.nvim_set_keymap('n', '<c-0>', [[<cmd>lua require('rose-pine.functions').select_variant('base')<cr>]], { noremap = true, silent = true })
|
|
```
|