Skip to content

README.md

Latest commit

 

History

History
52 lines (41 loc) · 1.49 KB

README.md

File metadata and controls

52 lines (41 loc) · 1.49 KB
Raw

snapshot.nvim

Create beautiful screenshots of your code, directly inside Neovim

Inspired by VSCode's Polacode Extension

Features

  • 📸 Code screenshots with syntax highlighting
  • 🎨 Customizable settings (line numbers, padding, shadow, render scale, etc.)
  • ⚡️ Blazingly fast Rust renderer

Installation

Prerequisites: Neovim >= 0.9.0

Use your favorite plugin manager!

Ex: using lazy.nvim

return {
  "smit4k/snapshot.nvim",
  config = function()
    require("snapshot").setup({
        -- Optional config settings, defaults shown below
        snapshot_dir = "~/Pictures/snapshots", -- Reccomended: directory where snapshot images are saved to
        --padding = 25,
        --line_height = 28,
        --font_size = 24,
        --shadow = true,
        --line_numbers = false,
        --start_line = 1,
        --border_radius = 5,
        --outer_background = "#ffffff", -- use #00000000 for transparent
        --outer_padding = 15,
        --clipboard = true,
    })
  end,
}

Usage

Select code in Visual mode and run :Snapshot. To capture an entire buffer, just run :Snapshot in Normal mode.

Contributing

Contributions are welcome! Please open an issue to discuss your ideas or problems or submit a pull request with your changes.