A Neovim plugin to create and manage decorative comment boxes and lines for code and plain text files.
comment-box.nvim is a Neovim plugin that allows users to create decorative boxes and lines around comments or text in code and plain text files. It solves the problem of manually formatting visual separators by providing easy commands to draw aligned boxes, integrate text into lines, and apply predefined styles, enhancing code readability and organization.
Neovim users who write code or plain text and want to improve visual structure through decorative comments, such as developers documenting config files, creating section dividers, or making notes stand out.
Developers choose comment-box.nvim for its simplicity and flexibility—it offers a wide range of styling options, automatic text wrapping, and easy removal of decorations, all without leaving the editor, making it a lightweight yet powerful tool for beautifying text.
:sparkles: Clarify and beautify your comments and plain text files using boxes and lines.
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Includes a catalog of 22 box styles and 17 line styles accessible via :CBcatalog, offering quick aesthetic choices without manual design.
Supports left, center, and right alignment for boxes and text, with adaptive box sizing to fit content, as detailed in the command nomenclature table.
Allows removal of boxes or lines while preserving original text via CBd, and yanking content without decorations with CBy, enhancing workflow efficiency.
Automatically wraps long text within boxes and titled lines to maintain visual structure, preventing overflow without manual intervention.
The author has announced a rewrite due to messy code, halting new feature additions and potentially delaying long-term improvements or bug fixes.
Explicitly does not support decorations for inline comments, limiting use in scenarios where comments are placed within code lines rather than on separate lines.
CBd and CBy commands fail with non-alphanumeric characters or specific punctuation, risking incomplete text extraction or errors when using custom styles.