Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeanguyomarch/vim-metacomment

Add a special framed, centered comment
https://github.com/jeanguyomarch/vim-metacomment

Last synced: 27 days ago
JSON representation

Add a special framed, centered comment

Awesome Lists containing this project

README

        

# vim-metacomment

## What does this thing do?

Basically, type `:MetaComment Blah blah, some text`, this inserts in your
buffer a boxed comment that looks like this, starting at the position of your
cursor:

```
//============================================================================//
// Blah blah, some text //
//============================================================================//
```

## Installation

With [vim-plug][1], add the following line to your vim/neovim configuration
file:

```
Plug 'jeanguyomarch/vim-metacomment'
```

## Usage

In a nutshell, just use `:MetaComment `. See the documentation (i.e.,
`:help vim-metacomment`) for details.

## Limitations

* The comment box is ill-formed if the cursor is not in the first column.
* The comment box does not support multi-line text.
* The size of the comment box is fixed.

## License

See [`LICENSE.md`](LICENSE.md).

[1]: https://github.com/junegunn/vim-plug