Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jbyuki/venn.nvim
Draw ASCII diagrams in Neovim
https://github.com/jbyuki/venn.nvim
ascii-art ascii-graphics diagrams neovim nvim
Last synced: 28 days ago
JSON representation
Draw ASCII diagrams in Neovim
- Host: GitHub
- URL: https://github.com/jbyuki/venn.nvim
- Owner: jbyuki
- License: mit
- Created: 2021-06-01T15:00:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-16T03:55:30.000Z (3 months ago)
- Last Synced: 2024-09-29T06:04:19.850Z (about 1 month ago)
- Topics: ascii-art, ascii-graphics, diagrams, neovim, nvim
- Language: Lua
- Homepage:
- Size: 35.2 KB
- Stars: 964
- Watchers: 8
- Forks: 21
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - jbyuki/venn.nvim - Draw ASCII diagrams. (Note Taking / Cursorline)
- my-neovim-pluginlist - jbyuki/venn.nvim - commit/jbyuki/venn.nvim)  (New features / Diagram)
README
venn.nvim
=========
Draw ASCII diagrams in Neovim.
Installation
------------
Install using your prefered method:
- [vim-plug](https://github.com/junegunn/vim-plug).
```vim
Plug 'jbyuki/venn.nvim'
```
- [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use "jbyuki/venn.nvim"
```
Usage
-----
* `set virtualedit=all` or `set ve=all`. This will allow you to freely move the cursor in the buffer. (see `help virtualedit`).
* Enter in Visual Block mode using `` or ``. Select the region where the box should be.
* Invoke `:VBox`. This will draw a rectangle. In case, it has a width or a height of 1, it will draw a line.
Key Mapping
-----------
### Using [hydra.nvim](https://github.com/nvimtools/hydra.nvim)
Any modal keymapping system would work to get additional keys usable for drawing
and moving selections, since there are many options to draw and move around pieces.
#### Draw diagrams
A relative complete configuration to draw diagrams with boxes, lines and arrows
in utf can be found
[in the hydra wiki](https://github.com/nvimtools/hydra.nvim/wiki/Draw-diagrams)
and the more extensive version including explanations
[in this repo wiki](https://github.com/jbyuki/venn.nvim/wiki/Draw-diagrams).
#### Moving selection
Drawing and text repositioning is a frequent operation on more complex
graphics. While `gR` allows to overwrite text from left to right, it does not
allow to move (text) selections around.
Using [mini.move](https://github.com/echasnovski/mini.move)
works with for now main usability restriction of
[no correct fixup after collisions](https://github.com/echasnovski/mini.nvim/issues/838)
and an example configuration can be found
[in the hydra wiki](https://github.com/nvimtools/hydra.nvim/wiki/Move-selection)
and the more extensive version including explanations
[in this repo wiki](https://github.com/jbyuki/venn.nvim/wiki/Move-selection).
### Using toggle command
You can map `:VBox` commands to allow different ways of drawing lines.
Use the following function in your neovim config to toggle drawing lines on `HJKL` directional keys to allow for faster creation of diagrams:
```lua
-- venn.nvim: enable or disable keymappings
function _G.Toggle_venn()
local venn_enabled = vim.inspect(vim.b.venn_enabled)
if venn_enabled == "nil" then
vim.b.venn_enabled = true
vim.cmd[[setlocal ve=all]]
-- draw a line on HJKL keystokes
vim.api.nvim_buf_set_keymap(0, "n", "J", "j:VBox", {noremap = true})
vim.api.nvim_buf_set_keymap(0, "n", "K", "k:VBox", {noremap = true})
vim.api.nvim_buf_set_keymap(0, "n", "L", "l:VBox", {noremap = true})
vim.api.nvim_buf_set_keymap(0, "n", "H", "h:VBox", {noremap = true})
-- draw a box by pressing "f" with visual selection
vim.api.nvim_buf_set_keymap(0, "v", "f", ":VBox", {noremap = true})
else
vim.cmd[[setlocal ve=]]
vim.api.nvim_buf_del_keymap(0, "n", "J")
vim.api.nvim_buf_del_keymap(0, "n", "K")
vim.api.nvim_buf_del_keymap(0, "n", "L")
vim.api.nvim_buf_del_keymap(0, "n", "H")
vim.api.nvim_buf_del_keymap(0, "v", "f")
vim.b.venn_enabled = nil
end
end
-- toggle keymappings for venn using v
vim.api.nvim_set_keymap('n', 'v', ":lua Toggle_venn()", { noremap = true})
```
