https://github.com/beixiyo/vv-dashboard.nvim

Lightweight startup dashboard for Neovim. 轻量启动页
https://github.com/beixiyo/vv-dashboard.nvim

dashboard greeter lua neovim neovim-plugin nvim nvim-plugin startup

Last synced: 17 days ago
JSON representation

Lightweight startup dashboard for Neovim. 轻量启动页

• Host: GitHub
• URL: https://github.com/beixiyo/vv-dashboard.nvim
• Owner: beixiyo
• License: mit
• Created: 2026-04-25T07:05:25.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2026-05-23T08:47:48.000Z (about 1 month ago)
• Last Synced: 2026-05-29T12:42:00.037Z (29 days ago)
• Topics: dashboard, greeter, lua, neovim, neovim-plugin, nvim, nvim-plugin, startup
• Language: Lua
• Size: 11.7 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
vv-dashboard.nvim




  极简 Neovim 启动页 — 单 buffer、非浮窗、与侧栏天然共存





  

  



---

## 安装

```lua

{

  'beixiyo/vv-dashboard.nvim',

  dependencies = { 'beixiyo/vv-utils.nvim' },

  event = 'VimEnter',

  ---@type VVDashboardConfig

  opts = {

    header = nil,           -- 多行 ASCII art（string 按 \n 分割，string[] 逐行）

    keys = {

      { icon = '󰈚', key = 'r', desc = '最近文件', action = 'Telescope oldfiles' },

      { icon = '󰈞', key = 'f', desc = '查找文件', action = 'Telescope find_files' },

      { icon = '', key = 'g', desc = '全局搜索', action = 'Telescope live_grep' },

      { icon = '', key = 'q', desc = '退出',     action = 'qa' },

    },

    footer = nil,           -- fun(): VVDashboardChunk[] | string | nil

    auto_open = true,       -- 启动时无参数 + 空 buffer 自动打开

    filetype = 'dashboard', -- dashboard buffer 的 filetype

    width = 60,             -- keys 区域容器宽度（两端对齐基准）

    key_gap = 1,            -- keys 之间的空行数

    section_gap = 2,        -- header / keys / footer 之间的空行数

  },

}

```

## 配置

| 选项 | 类型 | 默认值 | 说明 |

|------|------|--------|------|

| `header` | `string \| string[]` | *VSCode ASCII art* | 头部多行文本 |

| `keys` | `VVDashboardKey[]` | `{}` | 快捷键列表：`{ icon?, key, desc, action }` |

| `footer` | `fun(): VVDashboardChunk[] \| string \| nil` | `nil` | 底部内容，支持多色片段 `{ text, hl_group }[]` |

| `auto_open` | `boolean` | `true` | `VimEnter` 时无参数 + 空 buffer 自动打开 |

| `filetype` | `string` | `'dashboard'` | buffer filetype |

| `width` | `integer` | `60` | keys 区域容器宽度 |

| `key_gap` | `integer` | `1` | keys 之间的空行数 |

| `section_gap` | `integer` | `2` | 三段之间的空行数 |

| `highlights` | `VVDashboardHighlights` | *见源码* | 各段高亮组名（header / icon / desc / key / footer） |