Update README
This commit is contained in:
60
README.md
60
README.md
@@ -1,3 +1,59 @@
|
||||
# tokyodark.nvim
|
||||
|
||||

|
||||
|
||||
### About
|
||||
|
||||
A minimal and clean dark theme written in lua for neovim.
|
||||
|
||||
### Features
|
||||
- Support for numerous plugins
|
||||
- Customizable
|
||||
- Italic Support
|
||||
|
||||
### Installation
|
||||
Install with your favorite package manager:
|
||||
|
||||
[packer](https://github.com/wbthomason/packer.nvim)
|
||||
```lua
|
||||
use 'tiagovla/tokyodark.nvim'
|
||||
```
|
||||
|
||||
[vim-plug](https://github.com/junegunn/vim-plug)
|
||||
```vim
|
||||
Plug 'tiagovla/tokyodark.nvim'
|
||||
```
|
||||
|
||||
### Available configuration
|
||||
|
||||
**Note:** The configuration options should be placed before `colorscheme tokyodark` .
|
||||
|
||||
- `tokyonight_transparent_background`: Set to enable transparent background.
|
||||
- `tokyonight_enable_italic_comment`: Set to enable italic in `Comment` .
|
||||
- `tokyonight_enable_italic`: Set to italicize keywords. This option is
|
||||
designed to use with fonts that support italic styles, for example
|
||||
[Fira Code, MonoLisa, Dank Mono](https://www.nerdfonts.com/).
|
||||
- `tokyodark_color_gamma`: Change to adjust the brightness of the theme. (Darker < 1.0 < Lighter).
|
||||
|
||||
|
||||
#### Default configuration
|
||||
```lua
|
||||
-- init.lua
|
||||
vim.g.tokyodark_transparent_background = false
|
||||
vim.g.tokyodark_enable_italic_comment = true
|
||||
vim.g.tokyodark_enable_italic = true
|
||||
vim.g.tokyodark_color_gamma = 1.0
|
||||
vim.cmd("colorscheme tokyodark")
|
||||
```
|
||||
|
||||
```vim
|
||||
" .vimrc
|
||||
let g:tokyodark_transparent_background = 0
|
||||
let g:tokyodark_enable_italic_comment = 1
|
||||
let g:tokyodark_enable_italic = 1
|
||||
let g:tokyodark_color_gamma = 1.0
|
||||
colorscheme tokyodark
|
||||
```
|
||||
|
||||
|
||||
#### Inspiration
|
||||
* [tokyonight-vim](https://github.com/ghifarit53/tokyonight-vim)
|
||||
* [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme)
|
||||
|
||||
Reference in New Issue
Block a user