plugins.jupytext.settings

Options provided to the require('jupytext').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  custom_language_formatting = {
    python = {
      extension = "md";
      force_ft = "markdown";
      style = "markdown";
    };
  };
  force_ft = null;
  output_extension = "auto";
  style = "light";
}

Declared by:

plugins.jupytext.settings.custom_language_formatting

By default we use the auto mode of jupytext. This will create a script with the correct extension for each language. However, this can be overridden in a per language basis if you want to. For this you can set this option.

For example, to convert python files to quarto markdown:

  {
    python = {
      extension = "qmd";
      style = "quarto";
      force_ft = "quarto";
    };
  }

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

Default: null

Plugin default: { }

Declared by:

plugins.jupytext.settings.force_ft

Default filetype. Don’t change unless you know what you are doing.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.jupytext.settings.output_extension

By default, the extension of the plain text file is automatically selected by jupytext. This can be modified by changing the extension from auto to any other file extension supported by Jupytext. This is most useful to those using Quarto or Markdown. Analogously, we can provide a default filetype that will be given to the new buffer by using force_ft. Again, this is only really useful to users of Quarto.

Type: null or string or raw lua code

Default: null

Plugin default: "auto"

Declared by:

plugins.jupytext.settings.style

The jupytext style to use.

Type: null or string or raw lua code

Default: null

Plugin default: "hydrogen"

Declared by: