updated docs to include guicolors

This commit is contained in:
Rene Schallner
2021-12-09 18:36:19 +01:00
parent 5989d6e88b
commit 3f7d611c2c
2 changed files with 47 additions and 57 deletions

View File

@@ -1,6 +1,6 @@
# telekasten.nvim # telekasten.nvim
A Neovim (lua) plugin for working with a text-based, markdown [zettelkasten](https://takesmartnotes.com/) / Wiki and A Neovim (lua) plugin for working with a text-based, markdown [zettelkasten](https://takesmartnotes.com/) / wiki and
mixing it with a journal, based on [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim). mixing it with a journal, based on [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim).
#### Highlights: #### Highlights:
@@ -303,25 +303,22 @@ You can assign colors to the new syntax groups in your `init.vim`:
```vim ```vim
" just blue and gray links " just blue and gray links
hi tkLink ctermfg=Blue cterm=bold,underline hi tkLink ctermfg=Blue cterm=bold,underline guifg=blue gui=bold,underline
hi tkBrackets ctermfg=gray hi tkBrackets ctermfg=gray guifg=gray
" for gruvbox " for gruvbox
hi tkLink ctermfg=72 cterm=bold,underline hi tklink ctermfg=72 guifg=#689d6a cterm=bold,underline gui=bold,underline
hi tkBrackets ctermfg=gray hi tkBrackets ctermfg=gray guifg=gray
" highlight ==highlighted== text " real yellow
hi tkHighlight ctermbg=yellow ctermfg=darkred cterm=bold hi tkHighlight ctermbg=yellow ctermfg=darkred cterm=bold guibg=yellow guifg=darkred gui=bold
" gruvbox
"hi tkHighlight ctermbg=214 ctermfg=124 cterm=bold guibg=#fabd2f guifg=#9d0006 gui=bold
" for calendar, I prefer less prevalent navigation buttons
hi link CalNavi CalRuler hi link CalNavi CalRuler
hi tkTagSep ctermfg=gray guifg=gray
" colors for tags: hi tkTag ctermfg=175 guifg=#d3869B
hi tkTag ctermfg=175
" tag separator is only relevant in the following syntax:
" tags: [ tag1, tag2, tag3 ]
hi tkTagSep ctermfg=gray
``` ```
@@ -635,20 +632,17 @@ inoremap <leader>zt <ESC>:lua require('telekasten').toggle_todo({ i=true })<CR>
" ----- (see the section about coloring in README.md) " ----- (see the section about coloring in README.md)
" for gruvbox " for gruvbox
hi tkLink ctermfg=72 cterm=bold,underline hi tklink ctermfg=72 guifg=#689d6a cterm=bold,underline gui=bold,underline
hi tkBrackets ctermfg=gray hi tkBrackets ctermfg=gray guifg=gray
" highlight ==highlighted== text " real yellow
hi tkHighlight ctermbg=yellow ctermfg=darkred cterm=bold hi tkHighlight ctermbg=yellow ctermfg=darkred cterm=bold guibg=yellow guifg=darkred gui=bold
" gruvbox
"hi tkHighlight ctermbg=214 ctermfg=124 cterm=bold guibg=#fabd2f guifg=#9d0006 gui=bold
" for calendar, I prefer less prevalent navigation buttons
hi link CalNavi CalRuler hi link CalNavi CalRuler
hi tkTagSep ctermfg=gray guifg=gray
" colors for tags: hi tkTag ctermfg=175 guifg=#d3869B
hi tkTag ctermfg=175
" tag separator is only relevant in the following syntax:
" tags: [ tag1, tag2, tag3 ]
hi tkTagSep ctermfg=gray
``` ```
## 4. The hardcoded stuff ## 4. The hardcoded stuff

View File

@@ -2,7 +2,7 @@
*telekasten.nvim* *telekasten.nvim*
Telekasten.nvim is a plugin that lets you work with a folder of Markdown files Telekasten.nvim is a plugin that lets you work with a folder of Markdown files
and use it as a 'Zettelkasten' or a Wiki plus journal. and use it as a 'Zettelkasten' or a wiki plus journal.
Find notes by name, daily and weekly notes by date, search within all notes, Find notes by name, daily and weekly notes by date, search within all notes,
place and follow links to your notes or create new ones, with templates. place and follow links to your notes or create new ones, with templates.
@@ -295,23 +295,22 @@ I redefine the `CalNavi` class as well.
You can assign colors to the new syntax groups in your `init.vim`: You can assign colors to the new syntax groups in your `init.vim`:
> >
" just blue and gray links " just blue and gray links
hi tkLink ctermfg=Blue cterm=bold,underline hi tkLink ctermfg=Blue cterm=bold,underline guifg=blue gui=bold,underline
hi tkBrackets ctermfg=gray hi tkBrackets ctermfg=gray guifg=gray
" for gruvbox
hi tklink ctermfg=72 guifg=#689d6a cterm=bold,underline gui=bold,underline
hi tkBrackets ctermfg=gray guifg=gray
" for gruvbox " real yellow
hi tkLink ctermfg=72 cterm=bold,underline hi tkHighlight ctermbg=yellow ctermfg=darkred cterm=bold guibg=yellow guifg=darkred gui=bold
hi tkBrackets ctermfg=gray " gruvbox
"hi tkHighlight ctermbg=214 ctermfg=124 cterm=bold guibg=#fabd2f guifg=#9d0006 gui=bold
" highlight ==highlighted== text hi link CalNavi CalRuler
hi tkHighlight ctermbg=yellow ctermfg=darkred cterm=bold hi tkTagSep ctermfg=gray guifg=gray
hi tkTag ctermfg=175 guifg=#d3869B
" colors for tags:
hi tkTag ctermfg=175
" tag separator is only relevant in the following syntax:
" tags: [ tag1, tag2, tag3 ]
hi tkTagSep ctermfg=gray
< <
================================================================================ ================================================================================
@@ -768,20 +767,17 @@ However, here are some suggestions:
" (see the section about coloring in README.md) " (see the section about coloring in README.md)
" colors suitable for gruvbox color scheme " colors suitable for gruvbox color scheme
hi tkLink ctermfg=72 cterm=bold,underline hi tklink ctermfg=72 guifg=#689d6a cterm=bold,underline gui=bold,underline
hi tkBrackets ctermfg=gray hi tkBrackets ctermfg=gray guifg=gray
" highlight ==highlighted== text " real yellow
hi tkHighlight ctermbg=yellow ctermfg=darkred cterm=bold hi tkHighlight ctermbg=yellow ctermfg=darkred cterm=bold guibg=yellow guifg=darkred gui=bold
" gruvbox
"hi tkHighlight ctermbg=214 ctermfg=124 cterm=bold guibg=#fabd2f guifg=#9d0006 gui=bold
" for calendar, I prefer less prevalent navigation buttons hi link CalNavi CalRuler
hi link CalNavi CalRuler hi tkTagSep ctermfg=gray guifg=gray
hi tkTag ctermfg=175 guifg=#d3869B
" colors for tags:
hi tkTag ctermfg=175
" tag separator is only relevant in the following syntax:
" tags: [ tag1, tag2, tag3 ]
hi tkTagSep ctermfg=gray
< <
================================================================================ ================================================================================