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

sioyek-highlights

URL: https://github.com/jbuck95/nvim-sioyek-highlights/

Maintainers: Austin Horstman


Integrates Sioyek-like highlighting for docs and notes.

plugins.sioyek-highlights.enable

Whether to enable sioyek-highlights.

Type: boolean

Default:

false

Example:

true

Declared by:

plugins.sioyek-highlights.package

The sioyek-highlights package to use.

Type: package

Default:

pkgs.vimPlugins.nvim-sioyek-highlights

Declared by:

plugins.sioyek-highlights.autoLoad

Whether to automatically load sioyek-highlights when neovim starts.

Type: boolean

Default: false when lazy-loading is enabled.

Example:

false

Declared by:

plugins.sioyek-highlights.callSetup

Whether to generate the standard require('sioyek-highlights').setup(...) call for this plugin.

By default, this follows the plugin’s built-in behavior. Set this to false to disable the generated setup call, or to true to force it even when the plugin would only call it conditionally.

Type: null or boolean

Default:

null

Declared by:

plugins.sioyek-highlights.settings

Options provided to the require('sioyek-highlights').setup function.

Type: lua value

Default:

{ }

Example:

{
  db_path = "/srv/notes/sioyek.db";
  format_function = lib.nixvim.mkRaw ''
  function(text)
    return vim.tbl_map(function(line)
      return "> " .. line
    end, vim.split(text, "\n", { plain = true }))
  end
'';
}

Declared by: