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

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

|
||||
|
||||
|
||||
### About
|
||||
|
||||
A clean dark theme written in lua for neovim 0.5.
|
||||
|
||||
### 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` .
|
||||
**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`: 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).
|
||||
|
||||
- `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
|
||||
@@ -58,5 +63,6 @@ colorscheme tokyodark
|
||||
```
|
||||
|
||||
### 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