docs: better formatting
This commit is contained in:
22
README.md
22
README.md
@@ -1,44 +1,49 @@
|
|||||||

|

|
||||||
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
### About
|
### About
|
||||||
|
|
||||||
A clean dark theme written in lua for neovim 0.5.
|
A clean dark theme written in lua for neovim 0.5.
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- Support for numerous plugins
|
- Support for numerous plugins
|
||||||
- Customizable
|
- Customizable
|
||||||
- Italic Support
|
- Italic Support
|
||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
Install with your favorite package manager:
|
Install with your favorite package manager:
|
||||||
|
|
||||||
[packer](https://github.com/wbthomason/packer.nvim)
|
[packer](https://github.com/wbthomason/packer.nvim)
|
||||||
|
|
||||||
``` lua
|
``` lua
|
||||||
use 'tiagovla/tokyodark.nvim'
|
use 'tiagovla/tokyodark.nvim'
|
||||||
```
|
```
|
||||||
|
|
||||||
[vim-plug](https://github.com/junegunn/vim-plug)
|
[vim-plug](https://github.com/junegunn/vim-plug)
|
||||||
|
|
||||||
``` vim
|
``` vim
|
||||||
Plug 'tiagovla/tokyodark.nvim'
|
Plug 'tiagovla/tokyodark.nvim'
|
||||||
```
|
```
|
||||||
|
|
||||||
### Available configuration
|
### Available configuration
|
||||||
|
|
||||||
**Note:** The configuration options should be placed before `colorscheme tokyodark` .
|
**Note:** The configuration options should be placed before
|
||||||
|
`colorscheme tokyodark` .
|
||||||
|
|
||||||
- `tokyodark_transparent_background`: Set to enable transparent background.
|
- `tokyodark_transparent_background`: Set to enable transparent
|
||||||
|
background.
|
||||||
- `tokyodark_enable_italic_comment`: Set to enable italic in `Comment` .
|
- `tokyodark_enable_italic_comment`: Set to enable italic in `Comment` .
|
||||||
- `tokyodark_enable_italic`: Set to italicize keywords. This option is
|
- `tokyodark_enable_italic`: Set to italicize keywords. This option is
|
||||||
designed to use with fonts that support italic styles, for example
|
designed to use with fonts that support italic styles, for example
|
||||||
[Fira Code, MonoLisa, Dank Mono](https://www.nerdfonts.com/).
|
[Fira Code, MonoLisa, Dank Mono](https://www.nerdfonts.com/).
|
||||||
- `tokyodark_color_gamma`: Change to adjust the brightness of the theme. (Darker < 1.0 < Lighter).
|
- `tokyodark_color_gamma`: Change to adjust the brightness of the theme.
|
||||||
|
(Darker \< 1.0 \< Lighter).
|
||||||
|
|
||||||
#### Default configuration
|
#### Default configuration
|
||||||
|
|
||||||
``` lua
|
``` lua
|
||||||
-- init.lua
|
-- init.lua
|
||||||
vim.g.tokyodark_transparent_background = false
|
vim.g.tokyodark_transparent_background = false
|
||||||
@@ -58,5 +63,6 @@ colorscheme tokyodark
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Inspiration
|
### Inspiration
|
||||||
* [tokyonight-vim](https://github.com/ghifarit53/tokyonight-vim)
|
|
||||||
* [tokyo-night-vscode-theme](https://github.com/enkia/tokyo-night-vscode-theme)
|
- [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