plugins.codesnap.settings
Options provided to the require('codesnap').setup
function.
Type: attribute set of anything
Default:
{ }
Example:
{
breadcrumbs_separator = "/";
has_breadcrumbs = true;
has_line_number = false;
mac_window_bar = true;
save_path = "~/Pictures/Screenshots/";
title = "CodeSnap.nvim";
watermark = "";
}
Declared by:
plugins.codesnap.settings.bg_color
If you prefer solid color background, you can set bg_color to your preferred color.
Type: null or string or raw lua code
Default:
null
Plugin default: null
Example:
"#535c68"
Declared by:
plugins.codesnap.settings.bg_theme
Background theme name.
Check the upstream README for available options.
Type: null or string or raw lua code
Default:
null
Plugin default: "default"
Declared by:
plugins.codesnap.settings.breadcrumbs_separator
Separator for breadcrumbs.
The CodeSnap.nvim uses /
as the separator of the file path by default, of course, you can
specify any symbol you prefer as the custom separator.
Type: null or string or raw lua code
Default:
null
Plugin default: "/"
Declared by:
plugins.codesnap.settings.code_font_family
Which font to use for the code.
Type: null or string or raw lua code
Default:
null
Plugin default: "CaskaydiaCove Nerd Font"
Declared by:
plugins.codesnap.settings.has_breadcrumbs
Whether to display the current snapshot file path.
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.codesnap.settings.has_line_number
Whether to display line numbers.
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.codesnap.settings.mac_window_bar
Whether to display the MacOS style title bar.
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by:
plugins.codesnap.settings.min_width
Minimum width for the snapshot.
Type: null or unsigned integer, meaning >=0, or raw lua code
Default:
null
Plugin default: 0
Declared by:
plugins.codesnap.settings.save_path
The save_path must be ends with .png
, unless when you specified a directory path, CodeSnap
will append an auto-generated filename to the specified directory path.
For example:
save_path = "~/Pictures";
parsed:"~/Pictures/CodeSnap_y-m-d_at_h:m:s.png"
save_path = "~/Pictures/foo.png";
parsed:"~/Pictures/foo.png"
Type: null or string or raw lua code
Default:
null
Plugin default: null
Declared by:
plugins.codesnap.settings.show_workspace
Breadcrumbs hide the workspace name by default, if you want to display workspace in
breadcrumbs, you can just set this option to true
.
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.codesnap.settings.title
The editor title.
Type: null or string or raw lua code
Default:
null
Plugin default: "CodeSnap.nvim"
Declared by:
plugins.codesnap.settings.watermark
Wartermark of the code snapshot.
Type: null or string or raw lua code
Default:
null
Plugin default: "CodeSnap.nvim"
Declared by:
plugins.codesnap.settings.watermark_font_family
Which font to use for watermarks.
Type: null or string or raw lua code
Default:
null
Plugin default: "Pacifico"
Declared by: