Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

alpha

URL: https://github.com/goolord/alpha-nvim/

Maintainers: Heitor Augusto

plugins.alpha.enable

Whether to enable alpha.

Type: boolean

Default: false

Example: true

Declared by:

plugins.alpha.package

The alpha package to use.

Type: package

Default: pkgs.vimPlugins.alpha-nvim

Declared by:

plugins.alpha.autoLoad

Whether to automatically load alpha when neovim starts.

Type: boolean

Default: false when lazy-loading is enabled.

Example: false

Declared by:

plugins.alpha.settings

Options provided to the require('alpha').setup function.

Type: lua value

Default: { }

Example:

{
  layout = [
    {
      type = "padding";
      val = 2;
    }
    {
      opts = {
        hl = "Type";
        position = "center";
      };
      type = "text";
      val = [
        "███╗   ██╗██╗██╗  ██╗██╗   ██╗██╗███╗   ███╗"
        "████╗  ██║██║╚██╗██╔╝██║   ██║██║████╗ ████║"
        "██╔██╗ ██║██║ ╚███╔╝ ██║   ██║██║██╔████╔██║"
        "██║╚██╗██║██║ ██╔██╗ ╚██╗ ██╔╝██║██║╚██╔╝██║"
        "██║ ╚████║██║██╔╝ ██╗ ╚████╔╝ ██║██║ ╚═╝ ██║"
        "╚═╝  ╚═══╝╚═╝╚═╝  ╚═╝  ╚═══╝  ╚═╝╚═╝     ╚═╝"
      ];
    }
    {
      type = "padding";
      val = 2;
    }
    {
      type = "group";
      val = [
        {
          on_press = lib.nixvim.mkRaw "function() vim.cmd[[ene]] end";
          opts = {
            shortcut = "n";
          };
          type = "button";
          val = "  New file";
        }
        {
          on_press = lib.nixvim.mkRaw "function() vim.cmd[[qa]] end";
          opts = {
            shortcut = "q";
          };
          type = "button";
          val = " Quit Neovim";
        }
      ];
    }
    {
      type = "padding";
      val = 2;
    }
    {
      opts = {
        hl = "Keyword";
        position = "center";
      };
      type = "text";
      val = "Inspiring quote here.";
    }
  ];
}

Declared by:

plugins.alpha.theme

You can directly use a pre-defined theme.

Type: null or string

Default: null

Example: "dashboard"

Declared by: