https://github.com/meccin/shizukana.nvim
๐ธ An elegant and minimalist colorscheme for Neovim
https://github.com/meccin/shizukana.nvim
lsp lua neovim neovim-theme nvim syntax-highlighting terminal-colors theme tree-sitter-highlight
Last synced: about 1 month ago
JSON representation
๐ธ An elegant and minimalist colorscheme for Neovim
- Host: GitHub
- URL: https://github.com/meccin/shizukana.nvim
- Owner: meccin
- License: mit
- Created: 2025-08-03T23:22:20.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-12T17:59:31.000Z (11 months ago)
- Last Synced: 2026-01-11T11:29:23.739Z (5 months ago)
- Topics: lsp, lua, neovim, neovim-theme, nvim, syntax-highlighting, terminal-colors, theme, tree-sitter-highlight
- Language: Lua
- Homepage:
- Size: 24.4 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ๐ธ shizukana.nvim
A modern, soothing Neovim theme inspired by traditional Japanese aesthetics, focusing on visual comfort and accessibility.
## โจ Features
- ๐จ **Authentic Japanese Palette**: Colors inspired by sakura, torii, bamboo and traditional elements
- ๐๏ธ **Visual Comfort**: Developed with color science to reduce eye strain
- โฟ **WCAG AAA Accessibility**: 7:1 contrast ratio for maximum readability
- ๐ **Multiple Styles**: Moon (dark), Dawn (light), Dusk (twilight)
- ๐ง **TreeSitter & LSP**: Full support for modern semantic highlighting
- ๐ฏ **Dim Inactive**: Smart highlighting for active window
- ๐ **10+ Plugins**: Integration with Telescope, Lualine, nvim-tree and more
- ๐ **Performance**: Modular architecture with lazy loading
## ๐ฆ Installation
### Using [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
"avuenja/shizukana.nvim",
lazy = false,
priority = 1000,
config = function()
require("shizukana").setup({
-- your config here
})
vim.cmd.colorscheme("shizukana")
end,
}
```
### Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
"avuenja/shizukana.nvim",
config = function()
require("shizukana").setup({
-- your config here
})
vim.cmd.colorscheme("shizukana")
end,
}
```
## โ๏ธ Configuration
```lua
require("shizukana").setup({
style = "moon", -- "moon" | "dawn" | "dusk"
transparent = false, -- Transparent background
terminal_colors = true, -- Set terminal colors
dim_inactive = {
enabled = true, -- Dim inactive windows
shade = "dark",
percentage = 0.12, -- 12% darker
},
styles = {
comments = { italic = true },
keywords = { bold = true },
functions = {},
variables = {},
operators = {},
conditionals = { italic = true },
},
plugins = {
auto_detect = true, -- Auto-detect installed plugins
telescope = true,
nvim_tree = true,
lualine = true,
treesitter = true,
lsp = true,
cmp = true,
gitsigns = true,
indent_blankline = true,
},
-- Advanced callbacks
on_colors = function(colors)
-- Modify colors before applying
-- colors.bg = "#1a1a1a"
end,
on_highlights = function(highlights, colors)
-- Add custom highlights
-- highlights.MyCustomHL = { fg = colors.sakura }
end,
})
```
## ๐จ Color Palette
### Moon (Dark Mode)
| Color | Hex | Name | Usage |
| ----- | --------- | -------- | ---------------------- |
| ๐ธ | `#ffc0d9` | Sakura | Numbers, booleans |
| โฉ๏ธ | `#ff757f` | Torii | Errors, constants |
| ๐ | `#9ece6a` | Bamboo | Strings, git additions |
| ๐ | `#7aa2f7` | Sumi | Functions, links |
| ๐ฃ | `#bb9af7` | Murasaki | Keywords, statements |
| ๐ | `#e0af68` | Yamabuki | Types, warnings |
### Dawn (Light Mode)
| Color | Hex | Name | Usage |
| ----- | --------- | -------- | ---------------------- |
| ๐ธ | `#b4637a` | Sakura | Numbers, booleans |
| โฉ๏ธ | `#d20f39` | Torii | Errors, constants |
| ๐ | `#568a3a` | Bamboo | Strings, git additions |
| ๐ | `#286983` | Sumi | Functions, links |
| ๐ฃ | `#907aa9` | Murasaki | Keywords, statements |
| ๐ | `#ea9d34` | Yamabuki | Types, warnings |
### Dusk (Twilight Mode)
| Color | Hex | Name | Usage |
| ----- | --------- | -------- | ---------------------- |
| ๐ธ | `#d4a5b5` | Sakura | Numbers, booleans |
| โฉ๏ธ | `#e06b74` | Torii | Errors, constants |
| ๐ | `#8fb573` | Bamboo | Strings, git additions |
| ๐ | `#6494c4` | Sumi | Functions, links |
| ๐ฃ | `#a594c7` | Murasaki | Keywords, statements |
| ๐ | `#d4a76a` | Yamabuki | Types, warnings |
## ๐ ๏ธ Built-in Commands
```vim
:ShizukanaReload " Reload theme (useful during development)
:ShizukanaPalette " Show all palette colors
:ShizukanaContrast " Check WCAG contrast for all colors
:ShizukanaStyle " Toggle between moon/dawn/dusk
:ShizukanaExtras " Generate all extras passing style
:ShizukanaExtrasAll " Generate all extras to all styles (base16, starship, etc.)
```
## ๐ Project Structure
```
shizukana.nvim/
โโโ lua/
โ โโโ shizukana/
โ โโโ init.lua # Theme core
โ โโโ palette.lua # Color definitions
โ โโโ util.lua # Utility functions
โ โโโ groups/
โ โโโ init.lua # Base highlights
โ โโโ treesitter.lua # TreeSitter groups
โ โโโ lsp.lua # LSP semantic tokens
โ โโโ plugins.lua # Plugin integrations
โโโ colors/
โโโ shizukana.lua # Entry point
```
## ๐ฌ Science Behind the Theme
### WCAG Accessibility
- **AAA Standard**: Minimum 7:1 contrast ratio for normal text
- **AA Standard**: Minimum 4.5:1 contrast (exceeded by all colors)
- Relative luminance algorithm implemented for validation
### Visual Comfort
- **Background #1a1b26**: Avoids pure black to reduce excessive contrast
- **Pastel Colors**: Reduces visual vibration and halation
- **Color Temperature**: Optimized between 2700K-4000K for comfort
### Japanese Inspiration
- **Sakura (ๆก)**: Soft pink of cherry blossoms
- **Torii (้ณฅๅฑ
)**: Sacred red of Shinto gates
- **Yamabuki (ๅฑฑๅน)**: Golden yellow of yamabuki flowers
- **Bamboo (็ซน)**: Green of young bamboo
- **Sumi (ๅขจ)**: Blue of traditional ink
- **Murasaki (็ดซ)**: Historical noble purple
## ๐ค Contributing
Contributions are welcome! Please:
1. Fork the project
2. Create your feature branch (`git checkout -b feature/amazing`)
3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing`)
5. Open a Pull Request
## ๐ License
MIT License - see [LICENSE](LICENSE) for details.
## ๐ Acknowledgments
- Inspired by Japanese culture and aesthetics
- Based on WCAG accessibility research
- Influenced by themes like [tokyonight.nvim](https://github.com/folke/tokyonight.nvim), [kanagawa.nvim](https://github.com/rebelot/kanagawa.nvim), and [catppuccin](https://github.com/catppuccin/nvim)
---
**Made with ๐ธ for developers who value their eyes**
[Report Bug](https://github.com/avuenja/shizukana.nvim/issues) โข
[Request Feature](https://github.com/avuenja/shizukana.nvim/issues)