Skip to content

[Documentation update] Add note about vim.opt.shortmess to prevent brief display of original dashboard #534

Description

@josswright

Is your feature request related to a problem? Please describe.
On install, by default, the default Neovim intro message screen is shown very briefly before the dashboard. It took me down quite a rabbit hole playing with various configurations and options before I found that you can add an I to your vim.opt.shortmess options to disable this default intro message and get rid of that annoyance.

Feels like it would be a useful tip to include in the documentation. (Not knowing enough about plugin writing and order of execution, I don't know whether this could feasibly be set by the plugin itself.)

Describe the solution you'd like
Just a tip, somewhere in the README or documentation, to mention that you can resolve that brief flicker of the default intro message by adding an I to vim.opt.shortmess in your Neovim configuration. ($HOME/.config/nvim/lua/config/options.lua would be a default for a relatively standard lua-based configuration.)

Describe alternatives you've considered
I don't know if the plugin could set this option itself early enough in execution to prevent the problem. If it can, then having it as an option in the plugin itself would seem ideal. The dashboard in snacks.nvim avoids this, so I assume it's doing something along these lines, but I haven't dug that deep.

Additional context
This comes from me installing the plugin using lazy.nvim, although not LazyVim, so I did play a lot with lazy = false and setting priority. It could be that there's an alternative approach, but this seems fairly simple and neat, and I can imagine other people would benefit from it being mentioned in the documentation.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions