Color Highlighting documentation

Open
#523 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
38/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
lua
Domain
documentation

Research direction

Start with the README's Highlight and Example Config sections, then review issues 489, 473, and 226 for the existing context. Document where the listed highlight groups should be defined in the provided Lua configuration, and update the example so the placement and usage are clear.

Written by the indexing model from the issue text.

Description

This isn't well documented, I've already viewed multiple issues regarding this with the responses being not so helpful, to not helpful at all.

Documentation states there are highlight groups available for configuration
But where should this be defined in a configuration? An updated example in this section would be helpful, but as I've seen so far, each individual asking about this has had their issue answered and then immediately closed - none of these answers have been helpful thus far.

First issue searched, Again, where does DashboardDesc reside?
Second issue, I shouldn't need to change themes.
Third issue, yeah, the highlight groups are in the readme, but where should those reside in the configuration, should it be an autocommand, or a property in the lua file where this is loaded?

The highlight groups documented have zero context around them and does not speak to where they should exist.

Some information here, or an updated example would be helpful. Maybe I'm just being a moron, but I'll gladly admit to it and update the example if concrete advice is given.

return {
    'nvimdev/dashboard-nvim',
    event = 'VimEnter',
    config = function()
        require('dashboard').setup {
            theme = 'doom',
            config = {
                header = {
                    -- Some ASCII image
                },
                center = {
                    {
                        icon = ' ',
                        icon_hl = 'Group',
                        desc = 'Configure NeoVim [C]onfiguration files',
                        desc_hl = 'String',
                        key = 'c',
                        keymap = '<leader>sn',
                        key_hl = 'Number',
                        key_format = ' [%s]',
                        action = 'Telescope find_files',
                    },
                },
                footer = {
                    -- Some ASCII image
                },
                vertical_center = true,
            },
        }
    end,
    dependencies = { 'nvim-tree/nvim-web-devicons' },
}
Dominant language
Lua
Stars
2.9k
Forks
201
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nvimdev/dashboard-nvim

All issues in nvimdev/dashboard-nvim

Similar issues

More Lua issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.