plugins.magma-nvim.settings

The configuration options for magma-nvim without the magma_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal magma_foo_bar=1
  • hello = "world" -> :setglobal magma_hello="world"
  • some_toggle = true -> :setglobal magma_some_toggle
  • other_toggle = false -> :setglobal nomagma_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  automatically_open_output = true;
  cell_highlight_group = "CursorLine";
  image_provider = "none";
  output_window_borders = true;
  save_path = {
    __raw = "vim.fn.stdpath('data') .. '/magma'";
  };
  show_mimetype_debug = false;
  wrap_output = true;
}

Declared by:

plugins.magma-nvim.settings.automatically_open_output

If this is true, then whenever you have an active cell its output window will be automatically shown.

If this is false, then the output window will only be automatically shown when you’ve just evaluated the code. So, if you take your cursor out of the cell, and then come back, the output window won’t be opened (but the cell will be highlighted). This means that there will be nothing covering your code. You can then open the output window at will using :MagmaShowOutput.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.magma-nvim.settings.cell_highlight_group

The highlight group to be used for highlighting cells.

Type: null or string or raw lua code

Default: null

Plugin default: "CursorLine"

Declared by:

plugins.magma-nvim.settings.image_provider

This configures how to display images. The following options are available:

  • “none” – don’t show images.
  • “ueberzug” – use Ueberzug to display images.
  • “kitty” – use the Kitty protocol to display images.

Type: null or one of “none”, “ueberzug”, “kitty” or raw lua code

Default: null

Plugin default: "none"

Declared by:

plugins.magma-nvim.settings.output_window_borders

If this is true, then the output window will have rounded borders. If it is false, it will have no borders.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.magma-nvim.settings.save_path

Where to save/load with :MagmaSave and :MagmaLoad (with no parameters). The generated file is placed in this directory, with the filename itself being the buffer’s name, with % replaced by %% and / replaced by %, and postfixed with the extension .json.

Type: null or string or raw lua code

Default: null

Plugin default:

{
  __raw = "vim.fn.stdpath('data') .. '/magma'";
}

Declared by:

plugins.magma-nvim.settings.show_mimetype_debug

If this is true, then before any non-iostream output chunk, Magma shows the mimetypes it received for it. This is meant for debugging and adding new mimetypes.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.magma-nvim.settings.wrap_output

If this is true, then text output in the output window will be wrapped (akin to set wrap).

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: