plugins.marks.enable

Whether to enable marks.nvim.

Type: boolean

Default: false

Example: true

Declared by:

plugins.marks.package

Which package to use for the marks.nvim plugin.

Type: package

Default: <derivation vimplugin-marks.nvim-2024-01-07>

Declared by:

plugins.marks.builtinMarks

Which builtin marks to track and show. If set, these marks will also show up in the signcolumn and will update on |CursorMoved|.

Type: null or (list of (one of “'”, “^”, “.”, “<”, “>” or raw lua code))

Default: null

Plugin default: []

Declared by:

plugins.marks.cyclic

Whether forward/backwards movement should cycle back to the beginning/end of buffer.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.marks.defaultMappings

Whether to use the default plugin mappings or not. See |marks-mappings| for more.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.marks.excludedBuftypes

Which buftypes to ignore. If a buffer with this buftype is opened, then marks.nvim will not track any marks set in this buffer, and will not display any signs. Setting and moving to marks with ` or ’ will still work, but movement commands like “m]” or “m[” will not.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default: []

Declared by:

plugins.marks.excludedFiletypes

Which filetypes to ignore. If a buffer with this filetype is opened, then marks.nvim will not track any marks set in this buffer, and will not display any signs. Setting and moving to marks with ` or ’ will still work, but movement commands like “m]” or “m[” will not.

Type: null or (list of (string or raw lua code))

Default: null

Plugin default: []

Declared by:

plugins.marks.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.marks.forceWriteShada

If true, then deleting global (uppercase) marks will also update the |shada| file accordingly and force deletion of the mark permanently. This option can be destructive and should be set only after reading more about the shada file.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.marks.mappings

Custom mappings. Set a mapping to false to disable it.

Type: null or (attribute set of (string or value false (singular enum) or raw lua code))

Default: null

Plugin default: {}

Declared by:

plugins.marks.refreshInterval

How often (in ms) marks.nvim should update the marks list and recompute mark positions/redraw signs. Lower values means that mark positions and signs will refresh much quicker, but may incur a higher performance penalty, whereas higher values may result in better performance, but may also cause noticeable lag in signs updating.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 150

Declared by:

plugins.marks.signPriority

The sign priority to be used for marks. Can either be a number, in which case the priority applies to all types of marks, or a table with some or all of the following keys:

  • lower: sign priority for lowercase marks
  • upper: sign priority for uppercase marks
  • builtin: sign priority for builtin marks
  • bookmark: sign priority for bookmarks

Type: null or unsigned integer, meaning >=0, or (attribute set)

Default: null

Plugin default: 10

Declared by:

plugins.marks.signs

Whether to show marks in the signcolumn or not. If set to true, its recommended to also set |signcolumn| to “auto”, for cases where multiple marks are placed on the same line.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: