{"id":13412122,"url":"https://github.com/nvimdev/dashboard-nvim","last_synced_at":"2025-05-14T01:02:59.600Z","repository":{"id":37051560,"uuid":"270222620","full_name":"nvimdev/dashboard-nvim","owner":"nvimdev","description":"vim dashboard","archived":false,"fork":false,"pushed_at":"2025-01-22T08:01:28.000Z","size":404,"stargazers_count":2551,"open_issues_count":68,"forks_count":194,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-04-03T06:42:21.183Z","etag":null,"topics":["dashboard","neovim","neovim-plugin","vim","vim-plugin","vim-startify"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nvimdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"glepnir","custom":["https://www.paypal.me/bobbyhub"]}},"created_at":"2020-06-07T07:00:58.000Z","updated_at":"2025-04-02T15:29:18.000Z","dependencies_parsed_at":"2023-08-25T05:08:57.800Z","dependency_job_id":"92ec71e9-8d3b-463a-b696-75d740ebf425","html_url":"https://github.com/nvimdev/dashboard-nvim","commit_stats":{"total_commits":549,"total_committers":82,"mean_commits":6.695121951219512,"dds":0.3879781420765027,"last_synced_commit":"fabf5feec96185817c732d47d363f34034212685"},"previous_names":["glepnir/dashboard-nvim"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvimdev%2Fdashboard-nvim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvimdev%2Fdashboard-nvim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvimdev%2Fdashboard-nvim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nvimdev%2Fdashboard-nvim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nvimdev","download_url":"https://codeload.github.com/nvimdev/dashboard-nvim/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208688,"owners_count":21065204,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dashboard","neovim","neovim-plugin","vim","vim-plugin","vim-startify"],"created_at":"2024-07-30T20:01:21.208Z","updated_at":"2025-04-10T11:33:18.192Z","avatar_url":"https://github.com/nvimdev.png","language":"Lua","readme":"\u003ch1 align=\"center\"\u003e\n  Fancy and Blazing Fast start screen plugin of neovim\n\u003c/h1\u003e\n\n| \u003ccenter\u003eHyper\u003c/center\u003e | \u003ccenter\u003eDoom\u003c/center\u003e |\n| ---   | ---   |\n| \u003ccenter\u003e\u003cimg src=\"https://user-images.githubusercontent.com/41671631/215015845-b13343c4-427e-45d6-9f92-267ab909eff1.png\" width=80% height=80%/\u003e\u003c/center\u003e|\u003ccenter\u003e \u003cimg src=\"https://user-images.githubusercontent.com/41671631/214518543-d7d6afbf-f405-4a6f-a505-568c5a101e92.png\" width=80% height=80%/\u003e \u003c/center\u003e|\n\n# Feature\n\n- Low memory usage. dashboard does not store the all user configs in memory like header etc these string will take some memory. now it will be clean after you open a file. you can still use dashboard command to open a new one , then dashboard will read the config from cache.\n- Blazing fast\n\n\n# Install\n\n- Lazy.nvim\n\n```lua\n{\n  'nvimdev/dashboard-nvim',\n  event = 'VimEnter',\n  config = function()\n    require('dashboard').setup {\n      -- config\n    }\n  end,\n  dependencies = { {'nvim-tree/nvim-web-devicons'}}\n}\n```\n\n- Packer\n\n```lua\nuse {\n  'nvimdev/dashboard-nvim',\n  event = 'VimEnter',\n  config = function()\n    require('dashboard').setup {\n      -- config\n    }\n  end,\n  requires = {'nvim-tree/nvim-web-devicons'}\n}\n```\n\n# Configuration\n\n## Options\n\n```lua\ntheme = 'hyper'    -- theme is doom and hyper default is hyper\ndisable_move       -- default is false disable move keymap for hyper\nshortcut_type      -- shortcut type 'letter' or 'number'\nshuffle_letter     -- default is false, shortcut 'letter' will be randomize, set to false to have ordered letter\nletter_list        -- default is a-z, excluding j and k\nchange_to_vcs_root -- default is false,for open file in hyper mru. it will change to the root of vcs\nconfig = {},       -- config used for theme\nhide = {\n  statusline       -- hide statusline default is true\n  tabline          -- hide the tabline\n  winbar           -- hide winbar\n},\npreview = {\n  command          -- preview command\n  file_path        -- preview file path\n  file_height      -- preview file height\n  file_width       -- preview file width\n},\n```\n\n## Theme config\n\nthe `config` field is used for theme. general field\n\n```lua\nconfig = {\n  header -- type is table def\n  week_header = {\n    enable  --boolean use a week header\n    concat  --concat string after time string line\n    append  --table append after time string line\n  },\n  disable_move  -- boolean default is false disable move key\n}\n```\n\n### Hyper\n\nwhen use `hyper` theme the available options in `config` is\n\n```lua\nconfig = {\n  shortcut = {\n    -- action can be a function type\n    { desc = string, group = 'highlight group', key = 'shortcut key', action = 'action when you press key' },\n  },\n  packages = { enable = true }, -- show how many plugins neovim loaded\n  -- limit how many projects list, action when you press key or enter it will run this action.\n  -- action can be a function type, e.g.\n  -- action = func(path) vim.cmd('Telescope find_files cwd=' .. path) end\n  project = { enable = true, limit = 8, icon = 'your icon', label = '', action = 'Telescope find_files cwd=' },\n  mru = { enable = true, limit = 10, icon = 'your icon', label = '', cwd_only = false },\n  footer = {}, -- footer\n}\n```\n\n### Doom\n\nwhen use `doom` theme the available options in `config` is\n\n```lua\nconfig = {\n  center = {\n    {\n      icon = '',\n      icon_hl = 'group',\n      desc = 'description',\n      desc_hl = 'group',\n      key = 'shortcut key in dashboard buffer not keymap !!',\n      key_hl = 'group',\n      key_format = ' [%s]', -- `%s` will be substituted with value of `key`\n      action = '',\n    },\n  },\n  footer = {},\n  vertical_center = false, -- Center the Dashboard on the vertical (from top to bottom)\n}\n```\n\nnotice if you don't link config every highlight group. you can ignore this key.\ndashboard will use default highlight group like `DashboardKey/Icon/Desc` instead\n\n### Commands\n\n- `Dashboard` open dashboard\n- `DbProjectDelete count` delete project in cache works for hyper theme. count is number\n- `DashboardUpdateFooter` updates the content of the Footer\n\n### Highlight\n\nall highlight groups\n\n```\n-- General\nDashboardHeader DashboardFooter\n-- Hyper theme\nDashboardProjectTitle DashboardProjectTitleIcon DashboardProjectIcon\nDashboardMruTitle DashboardMruIcon DashboardFiles DashboardShortCutIcon\n-- Doom theme\nDashboardDesc DashboardKey DashboardIcon DashboardShortCut\n```\n\n### Example config\n\nexample config of screenshot\n\n\u003cdetails\u003e\n\u003csummary\u003e Hyper \u003c/summary\u003e\n\n```lua\n  db.setup({\n    theme = 'hyper',\n    config = {\n      week_header = {\n       enable = true,\n      },\n      shortcut = {\n        { desc = '󰊳 Update', group = '@property', action = 'Lazy update', key = 'u' },\n        {\n          icon = ' ',\n          icon_hl = '@variable',\n          desc = 'Files',\n          group = 'Label',\n          action = 'Telescope find_files',\n          key = 'f',\n        },\n        {\n          desc = ' Apps',\n          group = 'DiagnosticHint',\n          action = 'Telescope app',\n          key = 'a',\n        },\n        {\n          desc = ' dotfiles',\n          group = 'Number',\n          action = 'Telescope dotfiles',\n          key = 'd',\n        },\n      },\n    },\n  })\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e Doom \u003c/summary\u003e\n\n```lua\ndb.setup({\n  theme = 'doom',\n  config = {\n    header = {}, --your header\n    center = {\n      {\n        icon = ' ',\n        icon_hl = 'Title',\n        desc = 'Find File           ',\n        desc_hl = 'String',\n        key = 'b',\n        keymap = 'SPC f f',\n        key_hl = 'Number',\n        key_format = ' %s', -- remove default surrounding `[]`\n        action = 'lua print(2)'\n      },\n      {\n        icon = ' ',\n        desc = 'Find Dotfiles',\n        key = 'f',\n        keymap = 'SPC f d',\n        key_format = ' %s', -- remove default surrounding `[]`\n        action = 'lua print(3)'\n      },\n    },\n    footer = {}  --your footer\n  }\n})\n```\n\u003c/details\n\n### Changed\n\n- Removed Session as a start screen plugin speed is first.if you want use session you can take a\n  look at [glepnir/dbsession.nvim](https://github.com/glepnir/dbsession.nvim)\n- Removed Ueberzug script, as the Ueberzug author has deleted the repository.\n\n### TODO\n\n- I will write a plugin to implement some popular terminal evaluators image protocol then I think\n  can make it work with dashboard\n\n# Backers\n\n[@RakerZh](https://github.com/RakerZh)\n\n# Donate\n\nIf you'd like to support my work financially, buy me a drink through Github Sponsor or [![](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge\u0026logo=paypal\u0026logoColor=white)](https://paypal.me/bobbyhub)\n\n\n# LICENSE\n\nMIT\n","funding_links":["https://github.com/sponsors/glepnir","https://www.paypal.me/bobbyhub","https://paypal.me/bobbyhub"],"categories":["Startup","Lua"],"sub_categories":["Cursorline"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnvimdev%2Fdashboard-nvim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnvimdev%2Fdashboard-nvim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnvimdev%2Fdashboard-nvim/lists"}