Skip to content

Mange/dashboard-nvim

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fancy And Fastest Start Screen Plugin of Neovim

Stargazers Issues Contributors

Install

  • Packer
packer.use {'glepnir/dashboard-nvim'}

Option

local db = require('dashboard')
db.custom_header  -- type can be nil,table or function(must be return table in function)
                  -- if not config will use default banner
db.custom_center  -- table type and in this table you can set icon,desc,shortcut,action keywords. desc must be exist and type is string
                  -- icon type is nil or string
                  -- shortcut type is nil or string also like icon
                  -- action type can be string or function or nil.
                  -- if you don't need any one of icon shortcut action ,you can ignore it.
db.custom_footer  -- type can be nil,table or function(must be return table in function)
db.preview_file_Path    -- string type 
db.preview_file_height  -- string type
db.preview_file_width   -- string type
db.preview_command      -- string type
db.hide_statusline      -- boolean default is true.it will hide statusline in dashboard buffer and auto open in other buffer
db.hide_tabline         -- boolean default is true.it will hide tabline in dashboard buffer and auto open in other buffer

-- Highlight Group
DashboardHeader DashboardCenter DashboardCenterIcon DashboardShortCut DashboardFooter
  • Ascii Header text

    I collection some header texts in Wiki and you can preview these texts Preview

FQA

  • How to config like screenshot

    you need install lolcat and Thanks @sunjon create this neovim logo. you can find it in here

  local home = os.getenv('HOME')
  local db = require('dashboard')
  db.preview_command = 'cat | lolcat -F 0.3'
  db.preview_file_path = home .. '/.config/nvim/static/neovim.cat'
  db.preview_file_height = 12
  db.preview_file_width = 80
  db.custom_center = {
      {icon = '',
      desc = 'Recently laset session                  ',
      shortcut = 'SPC s l',
      action ='SessionLoad'},
      {icon = '',
      desc = 'Recently opened files                   ',
      action =  'DashboardFindHistory',
      shortcut = 'SPC f h'},
      {icon = '',
      desc = 'Find  File                              ',
      action = 'Telescope find_files find_command=rg,--hidden,--files',
      shortcut = 'SPC f f'},
      {icon = '',
      desc ='File Browser                            ',
      action =  'Telescope file_browser',
      shortcut = 'SPC f b'},
      {icon = '',
      desc = 'Find  word                              ',
      aciton = 'DashboardFindWord',
      shortcut = 'SPC f w'},
      {icon = '',
      desc = 'Open Personal dotfiles                  ',
      action = 'Telescope dotfiles path=' .. home ..'/.dotfiles',
      shortcut = 'SPC f d'},
    }
  • How to work with indentLine plugin?

    If you install some indentline plugin. you need config the option that can pass dashboard filetype dashboard to exclude filetyp

LICENSE

  • MIT

About

vim dashboard

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Lua 100.0%