Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sainnhe/gruvbox-material-vscode
Gruvbox Material for Visual Studio Code
https://github.com/sainnhe/gruvbox-material-vscode
theme visual-studio-code vscode vscode-theme
Last synced: about 1 month ago
JSON representation
Gruvbox Material for Visual Studio Code
- Host: GitHub
- URL: https://github.com/sainnhe/gruvbox-material-vscode
- Owner: sainnhe
- License: mit
- Created: 2019-08-20T07:28:42.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T04:59:23.000Z (over 1 year ago)
- Last Synced: 2024-06-10T01:37:05.677Z (3 months ago)
- Topics: theme, visual-studio-code, vscode, vscode-theme
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=sainnhe.gruvbox-material
- Size: 1.31 MB
- Stars: 211
- Watchers: 5
- Forks: 21
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
𝐆𝐫𝐮𝐯𝐛𝐨𝐱 𝐌𝐚𝐭𝐞𝐫𝐢𝐚𝐥
𝐃𝐚𝐫𝐤 𝐇𝐚𝐫𝐝 𝐅𝐥𝐚𝐭
𝐃𝐚𝐫𝐤 𝐌𝐞𝐝𝐢𝐮𝐦 𝐌𝐚𝐭𝐞𝐫𝐢𝐚𝐥
𝐃𝐚𝐫𝐤 𝐒𝐨𝐟𝐭 𝐇𝐢𝐠𝐡 𝐂𝐨𝐧𝐭𝐫𝐚𝐬𝐭
𝐋𝐢𝐠𝐡𝐭 𝐇𝐚𝐫𝐝 𝐅𝐥𝐚𝐭
𝐋𝐢𝐠𝐡𝐭 𝐌𝐞𝐝𝐢𝐮𝐦 𝐌𝐚𝐭𝐞𝐫𝐢𝐚𝐥
𝐋𝐢𝐠𝐡𝐭 𝐒𝐨𝐟𝐭 𝐇𝐢𝐠𝐡 𝐂𝐨𝐧𝐭𝐫𝐚𝐬𝐭
This color scheme is a port of [Gruvbox Material](https://github.com/sainnhe/gruvbox-material) for Visual Studio Code and its forks.
> Gruvbox Material is a modified version of [Gruvbox](https://github.com/morhetz/gruvbox), the contrast is adjusted to be softer in order to protect developers' eyes.
There are 3 palettes available in this color scheme, the screenshots above only show the `material` palette. See [sainnhe/gruvbox-material](https://github.com/sainnhe/gruvbox-material) for a preview of all palettes.
## Features
- Carefully designed color palette for eye protection.
- Switch back to the original color palette whenever you like.
- Customizable.
- Rich support for common file types.
- Semantic highlighting support.
- Italic support.
Optimized File Types and Syntax Extensions: (click on this line to expand)
The following file types and syntax extensions are basically optimized, but there might be some bugs and mistakes, feedback is welcome :)
- **Assembly:** [MASM](https://marketplace.visualstudio.com/items?itemName=bltg-team.masm)
- **C#:** builtin
- **C++:** buildin, [C/C++](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools), [Better C++ Syntax](https://marketplace.visualstudio.com/items?itemName=jeff-hykin.better-cpp-syntax)
- **C:** builtin, [C/C++](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)
- **Clojure:** builtin
- **CMake:** [CMake](https://marketplace.visualstudio.com/items?itemName=twxs.cmake)
- **CoffeeScript:** builtin
- **CSS:** builtin
- **Dart:** [Dart](https://marketplace.visualstudio.com/items?itemName=Dart-Code.dart-code)
- **Diff:** builtin
- **Dockerfile:** builtin, [vscode-docker-syntax](https://marketplace.visualstudio.com/items?itemName=dunstontc.vscode-docker-syntax), [Better Dockerfile Syntax](https://marketplace.visualstudio.com/items?itemName=jeff-hykin.better-dockerfile-syntax)
- **Elixir:** [vscode-elixir](https://marketplace.visualstudio.com/items?itemName=mjmcloug.vscode-elixir)
- **Elm:** [elm](https://marketplace.visualstudio.com/items?itemName=Elmtooling.elm-ls-vscode)
- **Erlang:** [erlang](https://marketplace.visualstudio.com/items?itemName=pgourlain.erlang)
- **F#:** builtin
- **Fish:** [fish-vscode](https://marketplace.visualstudio.com/items?itemName=skyapps.fish-vscode)
- **Fortran:** [Modern Fortran](https://marketplace.visualstudio.com/items?itemName=krvajalm.linter-gfortran)
- **Git:** builtin
- **Go:** builtin
- **GraphQL:** [GraphQL](https://marketplace.visualstudio.com/items?itemName=Prisma.vscode-graphql), [GraphQL for VSCode](https://marketplace.visualstudio.com/items?itemName=kumar-harsh.graphql-for-vscode)
- **Groovy:** builtin
- **Haskell:** [Haskell Syntax Highlighting](https://marketplace.visualstudio.com/items?itemName=justusadam.language-haskell)
- **Html:** builtin
- **Java:** builtin
- **JavaScript:** builtin ([~~Babel JavaScript~~](https://marketplace.visualstudio.com/items?itemName=mgmcdermott.vscode-language-babel) not recommend [#6](https://github.com/sainnhe/gruvbox-material-vscode/issues/6))
- **JSON:** builtin
- **JSX:** builtin
- **Julia:** [Julia](https://marketplace.visualstudio.com/items?itemName=julialang.language-julia)
- **Kotlin:** [Kotlin Language](https://marketplace.visualstudio.com/items?itemName=mathiasfrohlich.Kotlin)
- **LaTex:** [LaTex](https://marketplace.visualstudio.com/items?itemName=torn4dom4n.latex-support)
- **LESS:** builtin
- **Lisp:** [Lisp](https://marketplace.visualstudio.com/items?itemName=mattn.Lisp)
- **Lua:** builtin, [Lua Plus](https://marketplace.visualstudio.com/items?itemName=jep-a.lua-plus)
- **Makefile:** builtin
- **Markdown:** builtin
- **ObjectiveC:** builtin
- **Perl:** builtin
- **PHP:** builtin
- **PowerShell:** builtin
- **Protobuf:** [vscode-proto3](https://marketplace.visualstudio.com/items?itemName=zxh404.vscode-proto3)
- **Pug:** builtin
- **PureScript:** [PureScript IDE](https://marketplace.visualstudio.com/items?itemName=nwolverson.ide-purescript)
- **Python:** builtin, [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- **R:** builtin
- **reStructuredText:** [reStructuredText](https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext)
- **Ruby:** [VSCode Ruby](https://marketplace.visualstudio.com/items?itemName=wingrunr21.vscode-ruby), [Ruby Language Colorization](https://marketplace.visualstudio.com/items?itemName=groksrc.ruby)
- **Rust:** builtin, [Rust Analyzer](https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer), [vscode-rust-syntax](https://marketplace.visualstudio.com/items?itemName=dunstontc.vscode-rust-syntax)
- **SASS:** [Sass](https://marketplace.visualstudio.com/items?itemName=Syler.sass-indented)
- **Scala:** [Scala Syntax (official)](https://marketplace.visualstudio.com/items?itemName=scala-lang.scala)
- **Shell:** builtin, [Better Shell Syntax](https://marketplace.visualstudio.com/items?itemName=jeff-hykin.better-shellscript-syntax)
- **SQL:** builtin
- **Stylus:** [Stylus](https://marketplace.visualstudio.com/items?itemName=sysoev.language-stylus)
- **Swift:** builtin
- **Tmux:** [tmux](https://marketplace.visualstudio.com/items?itemName=malmaud.tmux)
- **TOML:** [Better TOML](https://marketplace.visualstudio.com/items?itemName=bungcip.better-toml)
- **TSX:** builtin
- **TypeScript:** builtin
- **VimL:** [vscode-viml-syntax](https://marketplace.visualstudio.com/items?itemName=dunstontc.viml)
- **VUE:** [jcbuisson.vue](https://marketplace.visualstudio.com/items?itemName=jcbuisson.vue), [liuji-jim.vue](https://marketplace.visualstudio.com/items?itemName=liuji-jim.vue)
- **Xml:** builtin
- **YAML:** builtin
## Installation
1. Press extensions icon in your editor.
2. Search for `sainnhe.gruvbox-material`.
3. Select this extension and press `install` button.
## Usage
1. Click the gear button in the lower left corner.
2. Click `Color Theme`.
3. Select Gruvbox Material in the list.
## Customization
There are some configuration options available in this theme, you can customize the palette, contrast, workbench style, etc. via user settings.
1. Click the gear button in the lower left corner.
2. Click `Settings`.
3. Select `Gruvbox Material` and change the settings.
## FAQ
**Q: How to enable cursive italic keywords?**
**A:** The `italicKeywords` is designed to use with fonts that support cursive italic styles. To enable this feature:
1. Install a font that supports cursive italic styles, for example: https://aka.sainnhe.dev/fonts
2. Set the `gruvboxMaterial.italicKeywords` option to `true` in user settings.
3. (optional) Set the `gruvboxMaterial.italicComments` option to `false` in user settings.
## Related Projects
See this [wiki page](https://github.com/sainnhe/gruvbox-material/wiki/Related-Projects).
### More Color Schemes
- [Everforest](https://github.com/sainnhe/everforest-vscode)
- [Edge](https://github.com/sainnhe/edge-vscode)
- [Sonokai](https://github.com/sainnhe/sonokai-vscode)
## Contributing
See [CONTRIBUTING.md](https://github.com/sainnhe/gruvbox-material-vscode/blob/master/CONTRIBUTING.md).
## Credits
- The color palette is based on [gruvbox](https://github.com/morhetz/gruvbox) by [@morhetz](https://github.com/morhetz)
- The color palette is adjusted by [@sainnhe](https://github.com/sainnhe)
- The icon is designed by [@GulajavaMinistudio](https://github.com/GulajavaMinistudio)
- The material workbench style is designed by [@sainnhe](https://github.com/sainnhe)
- The flat workbench style is designed by [@sainnhe](https://github.com/sainnhe)
- The high contrast workbench style is designed by [@GulajavaMinistudio](https://github.com/GulajavaMinistudio)
## Inspirations
- [morhetz/gruvbox](https://github.com/morhetz/gruvbox): original gruvbox
- [atom.io](https://atom.io): the `white` color in the dark variant
- [zefei/cake16](https://github.com/zefei/cake16): the `black` color in the light variant
- [material-theme/vsc-material-theme](https://github.com/material-theme/vsc-material-theme): the material workbench style
- [Binaryify/OneDark-Pro](https://github.com/Binaryify/OneDark-Pro): the flat workbench style
- [Monokai Pro](https://monokai.pro/vscode): the high contrast workbench style
- [Google Material Design](https://www.material.io)
## Maintainers
| [](https://github.com/sainnhe) | [](https://github.com/Z4RX) |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Sainnhe Park](https://github.com/sainnhe) | [Zolkin Andrew](https://github.com/Z4RX) |
## License
[MIT License](https://github.com/sainnhe/gruvbox-material-vscode/blob/master/LICENSE)