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

mini-comment

URL: https://github.com/nvim-mini/mini.comment/

Maintainers: Heitor Augusto

plugins.mini-comment.enable

Whether to enable mini-comment.

Type: boolean

Default: false

Example: true

Declared by:

plugins.mini-comment.package

The mini-comment package to use.

Type: package

Default: pkgs.vimPlugins.mini-comment

Declared by:

plugins.mini-comment.autoLoad

Whether to automatically load mini-comment when neovim starts.

Type: boolean

Default: false when lazy-loading is enabled.

Example: false

Declared by:

plugins.mini-comment.settings

Options provided to the require('mini.comment').setup function.

Type: lua value

Default: { }

Example:

{
  hooks = {
    post = lib.nixvim.mkRaw "function() end";
    pre = lib.nixvim.mkRaw "function() end";
  };
  mappings = {
    comment = "gc";
    comment_line = "gcc";
    comment_visual = "gc";
    textobject = "gc";
  };
  options = {
    custom_commentstring = lib.nixvim.mkRaw "nil";
    ignore_blank_line = false;
    pad_comment_parts = true;
    start_of_line = false;
  };
}

Declared by: