Chapter 1. Configuration Options

Package setup organised by package name.

Type: attribute set of (submodule)

Default: { }

Declared by:

Whether to enable ‹name›.

Type: boolean

Default: false

Example: true

Nix package to install that provides ‹name›. Can also be a list of packages to be installed, for example to include an optional dependency.

Type: package or list of package

Default: epkgs.‹name›

Packages that should be added to nixmacs' path.

Type: list of package

Default: [ ]

Example: [ pkgs.silver-searcher ]

Package name to be used within init.el.

Type: string

Default: "‹name›"

How early in the init.el the use-package declaration should appear.

Type: signed integer

Default: 1000

Example: 500

String to be passed to the :after keyword of use-package.

Type: (list of string) or string

Default: [ ]

Attribute set of bindings to be passed to :bind keyword of use-package.

Type: attribute set of strings or a nested attribute set of strings

Default: { }

List of bindings to be passed to :bind-keymap keyword of use-package.

Type: attribute set of strings or a nested attribute set of strings

Default: { }

Attribute set to be passed to the :chords keyword of use-package.

Type: attribute set of strings or a nested attribute set of strings

Default: { }

List of strings to be passed to :commands keyword of use-package.

Type: (list of string) or string

Default: [ ]

String to be passed to the :config keyword of use-package.

Type: strings concatenated with "\n"

Default: ""

Attribute set to be passed to the :custom keyword of use-package.

Type: attribute set of (int, float, bool, string, or null to represent a value in elisp )

Default: { }

Attribute set to be passed to the :custom-face keyword of use-package.

Type: attribute set of (int, float, bool, string, or null to represent a value in elisp )

Default: { }

Boolean to be passed to the :defer keyword of use-package.

Type: boolean

Default: false

String to be passed to the :defines keyword of use-package.

Type: strings concatenated with "\n"

Default: ""

String to be passed to the :delight keyword of use-package.

Type: null or string

Default: null

Boolean to be passed to the :demand keyword of use-package.

Type: boolean

Default: false

String to be passed to the :diminish keyword of use-package.

Type: null or string

Default: null

String to be passed to the :functions keyword of use-package.

Type: strings concatenated with "\n"

Default: ""

String to be passed to the :hook keyword of use-package.

Type: string

Default: ""

String to be passed to the :if keyword of use-package.

Type: strings concatenated with "\n"

Default: ""

String to be passed to the :init keyword of use-package.

Type: strings concatenated with "\n"

Default: ""

String to be passed to the :interpreter keyword of use-package.

Type: string

Default: ""

String to be passed to the :magic keyword of use-package.

Type: strings concatenated with "\n"

Default: ""

String to be passed to the :magic-fallback keyword of use-package.

Type: strings concatenated with "\n"

Default: ""

String to be passed to the :mode keyword of use-package.

Type: string

Default: ""

Package initialisation text.

Type: string

String to be passed to the :unless keyword of use-package.

Type: strings concatenated with "\n"

Default: ""

String to be passed to the :when keyword of use-package.

Type: strings concatenated with "\n"

Default: ""

Adaptive wrap indent variable.

Type: signed integer

Default: 2

Declared by:

Company backends for major modes.

Type: attribute set of list of string

Default: { }

Declared by:

Checkers to be added to flycheck-disabled-checkers.

Type: list of string

Default: [ ]

Declared by:

Whether to use lsp-deferred.

Type: boolean

Default: false

Declared by:

Modes to activate lsp in.

Type: list of string

Default: [ ]

Declared by:

Theme for neotree to be passed to neo-theme.

Type: string

Default: "arrow"

Declared by:

Bibliography file for org-ref

Type: string

Declared by:

Directory for org roam

Type: string

Declared by:

Modes to start smartparens on

Type: list of string

Declared by:

Whether to use smartparens-strict-mode.

Type: boolean

Default: false

Declared by:

Builds the TeX-view-program-selection variable.

Type: attribute set of string

Default: { }

Example: { output-pdf = "zathura"; }

Declared by:

Activate which-key default config.

Type: null or one of "bottom", "right", "right-bottom", "minibuffer"

Default: "bottom"

Example: null

Declared by:

Extra keybindings for command mode.

Type: attribute set of string

Default: { }

Declared by:

Keyboard layout to be passed to xah-fly-keys.

Type: one of "azerty", "azerty-be", "colemak", "colemak-mod-dh", "dvorak", "programer-dvorak", "qwerty", "qwerty-abnt", "qwertz", "workman"

Default: "qwerty"

Example: "dvorak"

Declared by:

Key to bind major mode bindings to.

Type: null or string

Default: null

Declared by:

Yasnippet snippet directory.

Type: string

Default: ''(list (concat user-emacs-directory "snippets/"))''

Declared by:

Type: lazy attribute set of raw value

Declared by:

Font string to use or null to not set font.

Type: null or string

Default: null

Example: "Source Code Pro 9"

Declared by:

Unicode font string to use or null to not set unicode font.

Type: null or string

Default: null

Example: "STIXGeneral"

Declared by:

Whether to enable theme.

Type: boolean

Default: false

Example: true

Declared by:

Emacs package for theme.

Type: package

Example: ${epkgs.dracula-theme}

Declared by:

Extra config to be added to the theme package.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Theme name to load in init-el.

Type: string

Default: config.appearance.theme.package.pname

Example: "dracula"

Declared by:

Whether to enable emacs customisation.

Type: boolean

Default: false

Example: true

Declared by:

File to save emacs customisations in.

Type: string or (path)

Default: "~/.emacs.d/custom.el"

Declared by:

Text to be put after package initialisation in init.el.

Type: strings concatenated with "\n\n"

Default: ""

Declared by:

Items to be put at the top of init.el. Should not rely on any package.

Type: strings concatenated with "\n\n"

Default: ""

Declared by:

Attribute set defining hydras.

Type: attribute set of (submodule)

Default: { }

Declared by:

Binding to run hydra on.

Type: string

Default: ""

Example: ''"global-map \"<f2>\""''

Declared by:

Bindings for this hydra.

Type: attribute set of (string or (submodule))

Default: { }

Example: { g = { command = "text-scale-increase"; name = "in"; } ; l = { command = "text-scale-decrease"; name = "out"; } ; }

Declared by:

Hydra body colour.

Type: null or one of "amaranth", "teal", "pink", "red", "blue"

Default: null

Example: "amaranth"

Declared by:

Description for the hydra.

Type: null or string

Default: null

Example: "zoom"

Declared by:

head-hint for the hydra.

Type: null or string

Default: null

Example: "nil"

Declared by:

Name of the hydra.

Type: string

Default: "‹name›"

Example: "hydra-zoom"

Declared by:

Key bindings for major modes.

Type: attribute set of (submodule)

Declared by:

Key bindings to be set for given major mode. Implementation is up to keybinding system.

Type: null or (attribute set of string)

Default: { }

Example: { r = "nix-repl"; }

Declared by:

Command to run for the major mode key. Default activates leader-‹name›-sub-map.

Type: string

Default: "leader-‹name›-sub-map"

Declared by:

Key for this keybinding.

Type: string

Default: "‹name›"

Declared by:

Whether to enable agda layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable better defaults.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable C/C++ layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable completion layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable coq layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable fish layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable git layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable haskell layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable ivy layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable javascript layer.

Type: boolean

Default: false

Example: true

Declared by:

Amount of indent in javascript modes.

Type: positive integer, meaning >0

Default: 2

Declared by:

Whether to enable LaTeX layer.

Type: boolean

Default: false

Example: true

Declared by:

Enable fold mode for latex mode.

Type: boolean

Default: false

Declared by:

Whether to enable Language Server Protocol Layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable lsp-ui mode.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Markdown Layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable mu4e email client.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Nix Layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable nixmacs base layer.

Type: boolean

Default: true

Example: true

Declared by:

Whether to enable notmuch email interface.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable ocaml layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable org layer.

Type: boolean

Default: false

Example: true

Declared by:

List of paths to add to org-agenda-files or a file containing a list of files within it.

Type: (path) or list of (path)

Default: [ ]

Declared by:

Whether to enable python layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable rust layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable systemd layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable treemacs layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable yaml layer.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable cancel minibuffer on mouse click.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable show-config command.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable C-a from Crux.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable debug mode.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable deleting trailing whitespace.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable electric-pair-mode.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable highlight line mode.

Type: boolean

Default: false

Example: true

Declared by:

Variables to be set in init.el.

Type: attribute set of (int, float, bool, string, or null to represent a value in elisp )

Default: { }

Declared by:

Whether to enable line numbers.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable let minibuffer inherit parent buffer's input mode.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable recentf-mode.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable smooth scrolling.

Type: boolean

Default: false

Example: true

Declared by: