Getting Started

Getting started

Requirements

• Neovim 0.12 or newer
• A terminal or GUI with true-color support

Neotheme checks the Neovim version when the colorscheme loads and enables termguicolors automatically.

Install with lazy.nvim

{
	"alsi-lawr/neotheme.nvim",
	lazy = false,
	priority = 1000,
	config = function()
		require("neotheme").setup()
		vim.cmd.colorscheme("neotheme")
	end,
}

Loading the theme eagerly with a high priority lets other UI plugins consume its highlight groups during their own setup.

Install with vim.pack

vim.pack.add({ "https://github.com/alsi-lawr/neotheme.nvim" })

require("neotheme").setup()
vim.cmd.colorscheme("neotheme")

First launch

The minimal setup selects gruber-dark-muted:

require("neotheme").setup()
vim.cmd.colorscheme("neotheme")

Confirm the active colorscheme and background from Neovim:

:lua print(vim.g.colors_name)
:lua print(vim.o.background)

The expected colorscheme name is neotheme. The default background is dark.

Select a theme

Pass a built-in name to setup before loading the colorscheme:

require("neotheme").setup({
	theme = "gruber-light-muted",
})

vim.cmd.colorscheme("neotheme")

There is no separate colorscheme command for each variant. :colorscheme gruber-light-muted is not valid. Theme selection belongs in setup; the colorscheme command is always neotheme.

See Themes for every built-in variant and its preview.

Enable plugin integrations

Plugin-specific highlights are opt-in:

require("neotheme").setup({
	integrations = {
		gitsigns = true,
		nvim_tree = true,
		telescope = true,
	},
})

vim.cmd.colorscheme("neotheme")

Neotheme defines highlight groups for enabled integrations without requiring or loading the plugin module. See Integrations for all supported keys.

Configure Lualine

Lualine uses its own theme selection:

require("neotheme").setup()
vim.cmd.colorscheme("neotheme")

require("lualine").setup({
	options = {
		theme = "neotheme",
	},
})

See Lualine for mode colors, load order, and theme refresh behavior.

Next steps

• Review every option in Configuration.
• Change colors by purpose in Palette Customization.
• Build a complete palette from scratch in Custom Themes.
• Diagnose setup or highlight issues in Troubleshooting.