onedarkpro.nvim

Use require("onedarkpro").setup({...}) to customize the theme. You only need to call this function if you wish to change the default settings. The configuration object supports overriding colors, highlights, styles, filetypes, plugins, and options.

require("onedarkpro").setup({
  colors = {},
  highlights = {},
  styles = {
    types = "NONE",
    -- ... other style keys
  },
  filetypes = {
    lua = true,
    -- ... other filetype keys
  },
  plugins = {
    nvim_lsp = true,
    -- ... other plugin keys
  },
  options = {
    cursorline = false,
    transparency = false,
    terminal_colors = true,
    lualine_transparency = false,
    highlight_inactive_windows = false,
  }
})

Install onedarkpro.nvim using your preferred Neovim package manager. To apply the theme, execute the command colorscheme onedark in your configuration.

-- Lazy
{
  "olimorris/onedarkpro.nvim",
  priority = 1000, -- Ensure it loads first,
}

-- somewhere in your config:
vim.cmd("colorscheme onedark")

-- Packer
use "olimorris/onedarkpro.nvim"

-- somewhere in your config:
vim.cmd("colorscheme onedark")

-- Vim-Plug
Plug "olimorris/onedarkpro.nvim"

-- somewhere in your config:
colorscheme onedark

To ensure full functionality, the following requirements must be met:

• Neovim 0.9.2 or higher
• termguicolors enabled in Neovim for true color support
• tree-sitter installed for full syntax highlighting
• An LSP server that supports semantic tokens (for semantic token support)

The colorscheme includes five built-in themes: onedark, onelight, onedark_vivid, onedark_dark, and vaporwave. Set the active theme using the standard Neovim command:

vim.cmd("colorscheme onedark")

You can create your own themes by defining a local file that implements the required theme structure and referencing it in your onedarkpro setup.

-- In your main Neovim configuration:
require("onedarkpro").setup({
  themes = {
    vaporwave = "~/.config/nvim/lua/plugins/colors/vaporwave.lua",
  },
})
vim.cmd([[colorscheme vaporwave]])

-- In your custom theme file (~/.config/nvim/lua/plugins/colors/vaporwave.lua):
require("onedarkpro.config").set_theme("vaporwave")
require("onedarkpro").load()

If you want to modify a specific part of the theme but don't know which highlight group is responsible:

1. Neovim 0.9+: Use the built-in :Inspect command while your cursor is on the text.
2. Older Neovim versions: Install the nvim-treesitter/playground plugin and use the :TSHighlightCapturesUnderCursor command.

The theme provides opinionated highlighting for many filetypes. You can enable or disable specific filetypes in the filetypes table. You can also use the all key to disable everything and then selectively enable specific ones.

-- Disable specific filetypes
require("onedarkpro").setup({
  filetypes = {
    markdown = false,
    ruby = false,
  }
})

-- Disable all filetypes
require("onedarkpro").setup({
  filetypes = {
    all = false
  }
})

-- Disable all, then enable specific ones
require("onedarkpro").setup({
  filetypes = {
    all = false,
    markdown = true,
    ruby = true,
  }
})

-- Add custom filetype highlights (e.g. Tree-sitter groups)
require("onedarkpro").setup({
  highlights = {
    ["@field.yaml"] = { fg = "${blue}", italic = true }
  }
})

Use the options table to toggle specific theme behaviors:

• cursorline: Enables/disables cursorline highlighting.
• transparency: Enables a transparent background for Normal, Folded, SignColumn, Statusline, and Tabline.
• terminal_colors: If true, applies theme colors to Neovim's :terminal.
• lualine_transparency: Controls center bar transparency.
• highlight_inactive_windows: Changes the background of windows when they lose focus.

-- Example: Enabling cursorline and transparency
require("onedarkpro").setup({
  colors = {
    cursorline = "#FF0000"
  },
  options = {
    cursorline = true,
    transparency = true,
    terminal_colors = false,
    highlight_inactive_windows = true
  }
})

The theme includes support for various plugins. You can enable or disable these highlight groups in the plugins table. You can also disable all plugin highlights at once using all = false.

-- Disable specific plugins
require("onedarkpro").setup({
  plugins = {
    nvim_lsp = false,
    polygot = false,
    treesitter = false
  }
})

-- Disable all plugins
require("onedarkpro").setup({
  plugins = {
    all = false
  }
})

-- Disable all, then enable specific ones
require("onedarkpro").setup({
  plugins = {
    all = false,
    nvim_lsp = true,
    treesitter = true
  }
})

You can modify the existing color palette or introduce new colors by providing a colors table in your configuration.

• To override an existing core color, use its name (e.g., red) as the key and provide a new hex code.
• To add a new color to the palette, provide a new name (e.g., my_new_red) and a hex code. These custom colors can then be referenced when creating custom highlight group overrides.

colors = {
  -- Overriding an existing color
  red = "#FF0000",
  
  -- Creating a new custom color
  my_new_red = "#f44336"
}