codesnap.nvim
A Neovim plugin for creating beautiful, customizable code snapshots with rich features like highlights, ASCII art, and watermarks.
What is codesnap.nvim?
CodeSnap.nvim is a Neovim plugin designed to create visually appealing snapshots of code snippets. It solves the problem of sharing code in a formatted, attractive way by generating images with syntax highlighting, custom backgrounds, and annotations. The plugin supports various output formats and features like ASCII art and code block highlighting.
Neovim users, particularly developers, technical writers, and educators who need to share code snippets in presentations, documentation, or social media with enhanced visual appeal.
Developers choose CodeSnap.nvim for its deep Neovim integration, high performance via a precompiled Rust backend, and extensive customization options for themes and snapshot elements, offering a streamlined alternative to external screenshot tools.
Overview
📸 Snapshot plugin with rich features that can make pretty code snapshots for Neovim
Use Cases
Best For
- Creating shareable code snippets for documentation or tutorials
- Generating visually appealing code images for social media or blogs
- Producing ASCII art snapshots for plain-text environments like comments
- Highlighting specific code blocks in snapshots for emphasis
- Adding custom watermarks and file path breadcrumbs to code snapshots
- Using custom themes from VSCode or Sublime Text in snapshots
Not Ideal For
- Teams using VSCode, Sublime Text, or other editors who need code snapshot functionality without switching to Neovim
- Projects requiring automated, batch generation of code snapshots from multiple files without manual editor interaction
- Environments where minimal setup and zero configuration are priorities, as the plugin requires Lua configuration and theme management
Pros & Cons
Pros
Provides seamless commands and Lua API within Neovim, allowing users to generate snapshots directly from the editor without external tools.
Supports custom themes from VSCode and Sublime Text via asset URLs, along with gradients, watermarks, and breadcrumbs for highly personalized snapshots.
Generates snapshots as PNG, SVG, HTML, or ASCII art, catering to different sharing needs like social media, documentation, or plain-text comments.
Uses a precompiled Rust backend for fast and stable snapshot generation, eliminating the need for manual compilation on most platforms.
Cons
Major version upgrades (e.g., v1 to v2) introduced breaking configuration changes and removed features like live preview, requiring manual migration.
Configuration is based on a Rust library and involves intricate Lua tables for themes and gradients, which can be daunting for users unfamiliar with the syntax.
Windows support is newly added and not thoroughly tested, as admitted in the README, potentially leading to instability or bugs on that platform.
Frequently Asked Questions
Related Projects
instant.nvimcollaborative editing in Neovim using built-in capabilities
nvim-biscuitsA neovim port of Assorted Biscuits. Ends up with more supported languages too.
urlview.nvim🔎 Neovim plugin for viewing all the URLs in a buffer
scratch.nvimCreate temporary playground files effortlessly. Find them later without worrying about filenames or locations.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.