plugins.neorg.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  load = {
    "core.concealer" = {
      config = {
        icon_preset = "varied";
      };
    };
    "core.defaults" = {
      __empty = null;
    };
    "core.dirman" = {
      config = {
        workspaces = {
          home = "~/notes/home";
          work = "~/notes/work";
        };
      };
    };
  };
}

Declared by:

plugins.neorg.settings.hook

A user-defined function that is invoked whenever Neorg starts up. May be used to e.g. set custom keybindings.

fun(manual: boolean, arguments?: string)

Type: null or raw lua code

Default: null

Declared by:

plugins.neorg.settings.lazy_loading

Whether to defer loading the Neorg core until after the user has entered a .norg file.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.neorg.settings.load

A list of modules to load, alongside their configurations.

Type: null or (attribute set of (anything or raw lua code))

Default: null

Plugin default: { }

Example:

{
  "core.concealer" = {
    config = {
      icon_preset = "varied";
    };
  };
  "core.defaults" = {
    __empty = null;
  };
  "core.dirman" = {
    config = {
      workspaces = {
        home = "~/notes/home";
        work = "~/notes/work";
      };
    };
  };
}

Declared by: