lee-shun/vim-dashboard

Install

vim-plug
```
Plug 'glepnir/dashboard-nvim'
```
dein
```
call dein#add('glepnir/dashboard-nvim')
```

Options

Config your excute tool by g:dashboard_default_executive,This option mean what fuzzy search plugins that you used. vim-clap and fzf.vim Telescope
```
" Default value is clap
let g:dashboard_default_executive ='clap'
```
Dashboard wrap some vim-clap and fzf.vim commands with window config, And the dashboard commands execute tool depends on what plugin you used
- DashboardFindFile same as
  - vim-clap: Clap history Clap files ++finder=rg --ignore --hidden --files
  - fzf.vim : Files
- DashboardFindHistory same as
  - vim-clap: Clap history
  - fzf.vim : History
- DashboardChangeColorscheme same as
  - vim-clap: Clap colors
  - fzf.vim : Colors
- DashboardFindWord same as
  - vim-clap: Clap grep2
  - fzf.vim : Rg
- DashboardJumpMark same as
  - vim-clap: Clap marks
  - fzf.vim : Marks
If you already define the vim-clap and fzf commands, just set your keymaps into the g:dashboard_custom_shortcut. If you want use the Dashboard wrap commands. you can define the dashboard commands keymap then set it into g:dashboard_custom_shortcut
```
eg : "SPC mean the leaderkey
    let g:dashboard_custom_shortcut={
      \ 'last_session'       : 'SPC s l',
      \ 'find_history'       : 'SPC f h',
      \ 'find_file'          : 'SPC f f',
      \ 'new_file'           : 'SPC c n',
      \ 'change_colorscheme' : 'SPC t c',
      \ 'find_word'          : 'SPC f a',
      \ 'book_marks'         : 'SPC f b',
      \ }
```
g:dashboard_custom_shortcut_icon custom the shortcut icon.like this

 let g:dashboard_custom_shortcut_icon['last_session'] = ' '
 let g:dashboard_custom_shortcut_icon['find_history'] = 'ﭯ '
 let g:dashboard_custom_shortcut_icon['find_file'] = ' '
 let g:dashboard_custom_shortcut_icon['new_file'] = ' '
 let g:dashboard_custom_shortcut_icon['change_colorscheme'] = ' '
 let g:dashboard_custom_shortcut_icon['find_word'] = ' '
 let g:dashboard_custom_shortcut_icon['book_marks'] = ' '

what does the shortcut do? just a tip like whichkey,on dashboard you just move the cursor and press enter

g:dashboard_default_header set the default header,dashboard provide some headers. you can choose the header that you like. defaule headers:

default evil skull superman garfield doraemon transformer bull sunshine clockmachine pikachu orangutan
cres lambada commicgirl commicgirl2 commicgirl3 commicgirl4 commicgirl5
commicgirl6 commicgirl7 commicgirl8 commicgirl9 commicgirl10 commicgirl11
commicgirl12 commicgirl13 commicgirl14 commicgirl15 commicgirl16 commicgirl17
commicgirl18 commicgirl19 hydra

Preview Headers

g:dashboard_custom_header custom the dashboard header (same as startify)
g:dashboard_custom_footer custom the dashboard footer (same as startify)
Dashboard provide session support with SessionLoad and SessionSave commands you can define keymap like this .
```
nmap <Leader>ss :<C-u>SessionSave<CR>
nmap <Leader>sl :<C-u>SessionLoad<CR>
```
set the dashboard_session_directory to change the session folder default is ~/.cache/vim/session

Highlight group

DashboardHeader
DashboardCenter
DashboardShortcut
DashboardFooter

Autocmd Dashboard DashboardReady same as vim-startify

g:dashboard_custom_section custom section, it's very easy to custom. like example.

let g:dashboard_custom_section={
  \ 'buffer_list': [' Recently lase session                 SPC b b'],
  \ }

function! BUFFER_LIST()
  Clap buffers
endfunction

some options for fzf g:dashboard_fzf_float default is 1, g:dashboard_fzf_engine default is rg other value is ag

Minial vimrc

you can replace the vim-clap or fzf.vim commands by dashboard commands

dashboard-nvim with vim-clap

Plug 'glepnir/dashboard-nvim'
Plug 'liuchengxu/vim-clap'

let g:mapleader="\<Space>"
nmap <Leader>ss :<C-u>SessionSave<CR>
nmap <Leader>sl :<C-u>SessionLoad<CR>
nmap <Leader>cn :<C-u>DashboardNewFile<CR>
nnoremap <silent> <Leader>fh :<C-u>Clap history<CR>
nnoremap <silent> <Leader>ff :<C-u>Clap files ++finder=rg --ignore --hidden --files<cr>
nnoremap <silent> <Leader>tc :<C-u>Clap colors<CR>
nnoremap <silent> <Leader>fa :<C-u>Clap grep2<CR>
nnoremap <silent> <Leader>fb :<C-u>Clap marks<CR>
nnoremap <silent> <Leader>cn :<C-u>DashboardNewFile<CR>

let g:dashboard_custom_shortcut={
  \ 'last_session'       : 'SPC s l',
  \ 'find_history'       : 'SPC f h',
  \ 'find_file'          : 'SPC f f',
  \ 'new_file'           : 'SPC c n',
  \ 'change_colorscheme' : 'SPC t c',
  \ 'find_word'          : 'SPC f a',
  \ 'book_marks'         : 'SPC f b',
  \ }

dashboard-nvim with fzf.vim

Plug 'glepnir/dashboard-nvim'
Plug 'junegunn/fzf.vim'

let g:mapleader="\<Space>"
nmap <Leader>ss :<C-u>SessionSave<CR>
nmap <Leader>sl :<C-u>SessionLoad<CR>
nmap <Leader>cn :<C-u>DashboardNewFile<CR>
nnoremap <silent> <Leader>fh :History<CR>
nnoremap <silent> <Leader>ff :Files<CR>
nnoremap <silent> <Leader>tc :Colors<CR>
nnoremap <silent> <Leader>fa :Rg<CR>
nnoremap <silent> <Leader>fb :Marks<CR>
nnoremap <silent> <Leader>cn :<C-u>DashboardNewFile<CR>

let g:dashboard_custom_shortcut={
  \ 'last_session'       : 'SPC s l',
  \ 'find_history'       : 'SPC f h',
  \ 'find_file'          : 'SPC f f',
  \ 'new_file'           : 'SPC c n',
  \ 'change_colorscheme' : 'SPC t c',
  \ 'find_word'          : 'SPC f a',
  \ 'book_marks'         : 'SPC f b',
  \ }

FAQ

What is it different from vim-startify ? dashbaord is inspired by doom-emacs, startify provides a list of many files, Mru oldfile, etc., but do we really need this list, we will only open one file, and the file list takes up a lot of space, the dashboard uses fuzzy search plugin pop-up menu, it saves a lot of space, and provides more functions.

How to work with indentline plugin ?

let g:indentLine_fileTypeExclude = ['dashboard']

How to disable tabline in dashboard buffer?

autocmd FileType dashboard set showtabline=0 | autocmd WinLeave <buffer> set showtabline=2

Donate

Do you like dashboard-nvim? buy me a coffe 😘!

Wechat	AliPay

Acknowledgement

Inspired by doom emacs
vim-startify

lee-shun / vim-dashboard

Install

Options

Minial vimrc

FAQ

Donate

Acknowledgement

LICENSE

About

Languages