Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marko-cerovac/material.nvim
:trident: Material colorscheme for NeoVim written in Lua with built-in support for native LSP, TreeSitter and many more plugins
https://github.com/marko-cerovac/material.nvim
colorscheme lua material neovim neovim-lua treesitter
Last synced: about 1 month ago
JSON representation
:trident: Material colorscheme for NeoVim written in Lua with built-in support for native LSP, TreeSitter and many more plugins
- Host: GitHub
- URL: https://github.com/marko-cerovac/material.nvim
- Owner: marko-cerovac
- License: gpl-2.0
- Created: 2021-03-21T00:44:43.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-04T22:34:13.000Z (about 2 months ago)
- Last Synced: 2024-04-04T23:25:28.863Z (about 2 months ago)
- Topics: colorscheme, lua, material, neovim, neovim-lua, treesitter
- Language: Lua
- Homepage:
- Size: 9.33 MB
- Stars: 901
- Watchers: 5
- Forks: 114
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-neovim - marko-cerovac/material.nvim - Material.nvim is a highly configurable colorscheme written in Lua and based on the material palette. (Colorscheme / Tree-sitter Supported Colorscheme)
- awesome-stars - marko-cerovac/material.nvim - :trident: Material colorscheme for NeoVim written in Lua with built-in support for native LSP, TreeSitter and many more plugins (Lua)
- awesome-stars - marko-cerovac/material.nvim - :trident: Material colorscheme for NeoVim written in Lua with built-in support for native LSP, TreeSitter and many more plugins (Lua)
- awesome-stars - material.nvim - in support for native LSP, TreeSitter and many more plugins | marko-cerovac | 624 | (Lua)
- awesome-stars - marko-cerovac/material.nvim - :trident: Material colorscheme for NeoVim written in Lua with built-in support for native LSP, TreeSitter and many more plugins (Lua)
- awesome-stars - marko-cerovac/material.nvim - :trident: Material colorscheme for NeoVim written in Lua with built-in support for native LSP, TreeSitter and many more plugins (Lua)
- awesome-neovim - marko-cerovac/material.nvim - Material.nvim is a highly configurable colorscheme written in Lua and based on the material palette. (Colorscheme / Tree-sitter Supported Colorscheme)
- awesome-neovim - marko-cerovac/material.nvim - Material.nvim is a highly configurable colorscheme written in Lua and based on the material palette. (Colorscheme / Tree-sitter Supported Colorscheme)
README
## material.nvim
The original [Material](https://material-theme.site) theme now available for [NeoVim](https://neovim.io/)
---
## 🔱 Info
A port of [Material](https://material-theme.site) colorscheme for NeoVim written in Lua
Material.nvim is meant to be a fast and modern colorscheme written in Lua that supports a lot of the new features
added to NeoVim like built-in [LSP](https://github.com/neovim/nvim-lspconfig) and [TreeSitter](https://github.com/nvim-treesitter/nvim-treesitter)
## 🌊 Features
+ 5 styles to choose from
+ Oceanic 
+ Deep ocean 
+ Palenight 
+ Lighter 
+ Darker 
+ Many supported plugins
+ Ability to change background on sidebar-like windows like Nvim-Tree, Packer, terminal etc.
+ Asynchronous highlight loading which makes the theme blazingly fast
+ Ability to select styles using [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
+ Added functions for live theme switching without the need to restart NeoVim
+ Two [Lualine](https://github.com/hoob3rt/lualine.nvim) themes
+ Default:
+ Stealth
## ⚡️ Requirements
+ Neovim >= 0.7.0
## ⚓ Installation
Install via your favourite package manager:
```lua
-- If you are using Packer
use 'marko-cerovac/material.nvim'
```
## 🐬 Usage
Enable the colorscheme:
```lua
--Lua:
vim.cmd 'colorscheme material'
```
For a comlete guide on usage and configuration of the theme, see ```:help material.nvim```.
## ⚙️ Configuration
+ There are 5 different styles available:
+ darker
+ lighter
+ oceanic
+ palenight
+ deep ocean
Set the desired style using:
```lua
--Lua:
vim.g.material_style = "deep ocean"
```
The configuration of different options is done trough a setup function
This is an example of the function with the default values
```lua
require('material').setup({
contrast = {
terminal = false, -- Enable contrast for the built-in terminal
sidebars = false, -- Enable contrast for sidebar-like windows ( for example Nvim-Tree )
floating_windows = false, -- Enable contrast for floating windows
cursor_line = false, -- Enable darker background for the cursor line
lsp_virtual_text = false, -- Enable contrasted background for lsp virtual text
non_current_windows = false, -- Enable contrasted background for non-current windows
filetypes = {}, -- Specify which filetypes get the contrasted (darker) background
},
styles = { -- Give comments style such as bold, italic, underline etc.
comments = { --[[ italic = true ]] },
strings = { --[[ bold = true ]] },
keywords = { --[[ underline = true ]] },
functions = { --[[ bold = true, undercurl = true ]] },
variables = {},
operators = {},
types = {},
},
plugins = { -- Uncomment the plugins that you use to highlight them
-- Available plugins:
-- "coc"
-- "dap",
-- "dashboard",
-- "eyeliner",
-- "fidget",
-- "flash",
-- "gitsigns",
-- "harpoon",
-- "hop",
-- "illuminate",
-- "indent-blankline",
-- "lspsaga",
-- "mini",
-- "neogit",
-- "neotest",
-- "neo-tree",
-- "neorg",
-- "noice",
-- "nvim-cmp",
-- "nvim-navic",
-- "nvim-tree",
-- "nvim-web-devicons",
-- "rainbow-delimiters",
-- "sneak",
-- "telescope",
-- "trouble",
-- "which-key",
-- "nvim-notify",
},
disable = {
colored_cursor = false, -- Disable the colored cursor
borders = false, -- Disable borders between verticaly split windows
background = false, -- Prevent the theme from setting the background (NeoVim then uses your terminal background)
term_colors = false, -- Prevent the theme from setting terminal colors
eob_lines = false -- Hide the end-of-buffer lines
},
high_visibility = {
lighter = false, -- Enable higher contrast text for lighter style
darker = false -- Enable higher contrast text for darker style
},
lualine_style = "default", -- Lualine style ( can be 'stealth' or 'default' )
async_loading = true, -- Load parts of the theme asyncronously for faster startup (turned on by default)
custom_colors = nil, -- If you want to override the default colors, set this to a function
custom_highlights = {}, -- Overwrite highlights with your own
})
```
After passing the configuration to a setup function, make sure to enable the colorscheme:
```lua
vim.cmd 'colorscheme material'
```
This is an example of overwriting the default highlights and colors (most users will never need to do this)
```lua
local material = require 'material'
local colors = require 'material.colors'
material.setup{
custom_highlights = {
LineNr = { bg = '#FF0000' },
CursorLine = { fg = colors.editor.constrast , underline = true },
-- Dynamically override highlight groups with functions to ensure colors are
-- updated when changing styles at runtime
TabLine = function(colors, _)
return {
fg = colors.main.gray,
italic = true,
}
end,
TabLineSel = function(_, highlights)
return vim.tbl_extend(
"force",
highlights.main_highlights.editor()["TabLineSel"],
{ bold = true }
)
end,
-- This is a list of possible values
YourHighlightGroup = {
fg = "#SOME_COLOR", -- foreground color
bg = "#SOME_COLOR", -- background color
sp = "#SOME_COLOR", -- special color (for colored underlines, undercurls...)
bold = false, -- make group bold
italic = false, -- make group italic
underline = false, -- make group underlined
undercurl = false, -- make group undercurled
underdot = false, -- make group underdotted
underdash = false, -- make group underslashed
striketrough = false, -- make group striked trough
reverse = false, -- reverse the fg and bg colors
link = "SomeOtherGroup" -- link to some other highlight group
}
},
-- Custom colors must be a function that takes in the default colors table as
-- a paramter, and then modifies them.
-- To see the available colors, see lua/material/colors/init.lua
custom_colors = function(colors)
colors.editor.bg = "#SOME_COLOR"
colors.main.purple = "#SOME_COLOR"
colors.lsp.error = "#SOME_COLOR"
end
}
```
To enable transparency, it is suggested you disable the theme background from
the settings above. That way, your terminal's background will be used instead.
```lua
require('material').setup({
-- ... other settings
disable = {
-- ... other settings
background = true,
},
})
```
To enable the lualine themes, first set the theme in your lualine settings to `auto` or `material`
```lua
require('lualine').setup {
options = {
-- ... your lualine config
theme = 'auto'
or
theme = 'material'
-- ... your lualine config
}
}
```
Then, choose the style trough a variable called ```lualine_style``` in the theme setup function
```lua
require('material').setup({
lualine_style = 'default' -- the default style
or
lualine_style = 'stealth' -- the stealth style
})
```
If the theme, doesn't look right, it's probably because material.nvim is being loaded before lualine,
causing the other material theme that comes built-in to lualine to be used.
To fix this, either load material.nvim after lualine (preferred way)
or set the lualine theme to one of these two values in your lualine settings
```lua
require('lualine').setup {
options = {
-- ... your lualine config
theme = 'material-nvim' -- the default style
or
theme = 'material-stealth' -- the stealth style
-- ... your lualine config
}
}
```
## ⛵ Functions
+ Use Telescope.nvim to switch styles
```vim
:lua require("material.functions").find_style()
```
+ Cycle trough styles
```vim
:lua require('material.functions').toggle_style()
```
+ Toggle the end of buffer lines ( ~ )
```vim
:lua require('material.functions').toggle_eob()
```
+ Change the style to a desired one using the function change_style("desired style")
```vim
:lua require('material.functions').change_style("palenight")
```