plugins.notebook-navigator.settings

Options provided to the require('notebook-navigator').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  activate_hydra_keys = "<leader>h";
  cell_highlight_group = "Folded";
  cell_markers = {
    python = "# %%";
  };
  hydra_keys = {
    add_cell_after = "b";
    add_cell_before = "a";
    comment = "c";
    move_down = "j";
    move_up = "k";
    run = "X";
    run_and_move = "x";
    split_cell = "s";
  };
  repl_provider = "molten";
  syntax_highlight = true;
}

Declared by:

plugins.notebook-navigator.settings.activate_hydra_keys

If not nil the keymap defined in the string will activate the hydra head. If you don’t want to use hydra you don’t need to install it either.

Type: null or string or raw lua code

Default: null

Plugin default: null

Declared by:

plugins.notebook-navigator.settings.cell_highlight_group

For use with mini.hipatterns to highlight cell markers.

Type: null or string or raw lua code

Default: null

Plugin default: "Folded"

Declared by:

plugins.notebook-navigator.settings.cell_markers

Code cell marker.

Cells start with the marker and end either at the beginning of the next cell or at the end of the file.

By default, uses language-specific double percent comments like # %%. This can be overridden for each language with this setting.

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

Default: null

Plugin default: { }

Example:

{
  python = "# %%";
}

Declared by:

plugins.notebook-navigator.settings.hydra_keys

Mappings while the hydra head is active.

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

Default: null

Plugin default:

{
  add_cell_after = "b";
  add_cell_before = "a";
  comment = "c";
  move_down = "j";
  move_up = "k";
  run = "X";
  run_and_move = "x";
  split_cell = "s";
}

Declared by:

plugins.notebook-navigator.settings.repl_provider

The repl plugin with which to interface.

Current options:

  • “iron” for iron.nvim,
  • “toggleterm” for toggleterm.nvim,
  • “molten” for molten-nvim
  • “auto” which checks which of the above are installed

Type: null or one of “auto”, “iron”, “molten”, “toggleterm” or raw lua code

Default: null

Plugin default: "auto"

Declared by:

plugins.notebook-navigator.settings.show_hydra_hint

If true a hint panel will be shown when the hydra head is active. If false you get a minimalistic hint on the command line.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.notebook-navigator.settings.syntax_highlight

Syntax based highlighting.

If you don’t want to install mini.hipattners or enjoy a more minimalistic look.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by: