๐ธ Snapshot plugin with rich features that can make pretty code snapshots for Neovim
Warning
v1.0.0 will bring some break changes
- The
CodeSnapPreviewOn
command is not supported, if you prefer live-preview, you can pinCodeSnap.nvim
version tov0.0.11
to continue using this command. - The
opacity
andpreview_title
config has been removed from v1.0.0 - The
editor_font_family
was renamed tocode_font_family
- ๐คฉ Beautiful code snap template
- ๐ Custom watermark and window style
- ๐ป Beautiful Mac-style title bar
- ๐ค Generate snapshots using only a single command
- ๐ Breadcrumbs for display file path
- ๐ More beautiful background theme
- ๐ข [WIP] Column number
- Neovim 9.0+
Recommend using Lazy.nvim for installation, but you can still use another plugin manager you prefer.
Lazy.nvim
{ "mistricky/codesnap.nvim", build = "make", version = "^1" },
Since v0.0.1 was released, the CodeSnap.nvim will cross-compile for the following three targets, then the CodeSnap.nvim will automatically determine which package to use based on your system, you no longer need to have Rust environment if everything goes smoothly.
- x86_64-unknown-linux-gnu
- x86_64-apple-darwin
- aarch64-apple-darwin
If CodeSnap.nvim on your system still not works fine, there are a lot of reasons depending on your system arch or OS version, well you can try to build CodeSnap manually using the following config:
{ "mistricky/codesnap.nvim", build = "make build_generator", version = "^1" },
CodeSnap.nvim
provides the following two ways to take snapshots of currently selected code
To take a beautiful snapshot use CodeSnap.nvim, you can just use CodeSnap
command to generate a snapshot of the current selected code, then the CodeSnap.nvim
will write the snapshot into the clipboard, and you can paste it anywhere you want.
Clipboard.mov
Of course, you can use CodeSnapSave
command to save the snapshot to path where you defined it in config.save_path
require("codesnap").setup({
-- ...
save_path = ...
})
Save.mov
Breadcrumbs are something to display the current snapshot file path, you can open it through config has_breadcrumbs
:
require("codesnap").setup({
-- ...
has_breadcrumbs = true
})
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:
require("codesnap").setup({
-- ...
has_breadcrumbs = true
breadcrumbs_separator = "๐"
})
The CodeSnap.nvim
comes with many beautiful backgrounds preset, you can set any background you like by setting bg_theme
to its name, just like:
require("codesnap").setup({
-- The "default" background is one you see at the beginning of the README
bg_theme = "default"
})
bamboo | sea |
---|---|
peach | grape |
dusk | summer |
If you prefer solid color background, you can set bg_color
to your preferred color. For example:
require("codesnap").setup({
-- ...
bg_color = "#535c68"
})
Watermark is something that makes screenshots more personalized, but if you don't like watermark just set it as an empty string to hide it.
require("codesnap").setup({
-- ...
watermark = ""
})
CodeSnap # Take a snapshot of the currently selected code and copy the snapshot into the clipboard
CodeSnapSave # Save the snapshot of the currently selected code and save it on the disk
Define your custom config using setup
function
require("codesnap").setup({...})
There is a default config:
{
mac_window_bar = true,
title = "CodeSnap.nvim",
code_font_family = "CaskaydiaCove Nerd Font",
watermark_font_family = "Pacifico",
watermark = "CodeSnap.nvim",
bg_theme = "default"
}
MIT.