From a727844f4f14f0d89c658e9ddf87d2f744562230 Mon Sep 17 00:00:00 2001 From: tiagovla Date: Sat, 23 Oct 2021 01:53:30 -0300 Subject: [PATCH] docs: better formatting --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f5bfbc1..a547f0f 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,50 @@ ![tokyodark.nvim](https://svgur.com/i/WVs.svg) - ![image](https://user-images.githubusercontent.com/30515389/115807570-42385080-a3bf-11eb-8286-c981b5093ffa.png) - ### 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 + +``` lua use 'tiagovla/tokyodark.nvim' ``` [vim-plug](https://github.com/junegunn/vim-plug) -```vim + +``` 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 + +``` lua -- init.lua vim.g.tokyodark_transparent_background = false vim.g.tokyodark_enable_italic_comment = true @@ -48,7 +53,7 @@ vim.g.tokyodark_color_gamma = "1.0" vim.cmd("colorscheme tokyodark") ``` -```vim +``` vim " .vimrc let g:tokyodark_transparent_background = 0 let g:tokyodark_enable_italic_comment = 1 @@ -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)