Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/protex/better-digraphs.nvim
Better digraphs plugin based on idea from Damian Conway
https://github.com/protex/better-digraphs.nvim
Last synced: 3 days ago
JSON representation
Better digraphs plugin based on idea from Damian Conway
- Host: GitHub
- URL: https://github.com/protex/better-digraphs.nvim
- Owner: protex
- Created: 2022-02-04T16:18:32.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-24T18:53:05.000Z (6 months ago)
- Last Synced: 2024-08-02T13:34:00.590Z (3 months ago)
- Language: Lua
- Homepage:
- Size: 261 KB
- Stars: 44
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Better Digraphs
Digraphs are incredibly useful, but oftentimes hard to remember. The `h digraph-table` and `h digaph-table-mbyte` entries are helpful, but cumbersome and their usage tends to interrupt the natural flow that every nvim user aspires to. Enter better-digraphs, a plugin that improves the digraph experience in nvim by adding the contents of the `digraph-table-mbyte` to a telescope finder.
# Example
https://user-images.githubusercontent.com/3252946/155826375-69ec4a47-645a-4fe6-8724-162479973e65.mov
# Installation
Requires Neovim >= 0.7
Using vim plug
```vim
Plug 'nvim-telescope/telescope.nvim'
Plug 'protex/better-digraphs.nvim'
```
# Usage
The recommended mappings for this plugin are the following:
```vim
inoremap lua require'better-digraphs'.digraphs("insert")
nnoremap r lua require'better-digraphs'.digraphs("normal")
vnoremap r lua require'better-digraphs'.digraphs("visual")
```
## What if I've re-mapped to something else
You can change the command sequence that better digraphs uses to enter digraph mode. ( is helpful for creating the proper control characters)
```lua
vim.g.digraph_map_sequences = {
insert = "",
normal = "",
visual = ""
}
```
# Adding or modifying digraphs
Adding or modifying digraphs can be done by setting the `vim.g.BetterDigraphsAdditions` variable
### Example
Modifying the `OK` (✓) digraph to be `*`, and adding a new `zz` digraph that maps to `Z`:
```lua
vim.g.BetterDigraphsAdditions = {
{
digraph = "OK",
symbol = "*",
name = "NEW STAR"
},
{
digraph = "zz",
symbol = "Z",
name = "CAPITAL Z"
}
}
```
This will allow the usage of the normal `` in insert mode, single character replace, and multiple character replace, but allows you to quickly pull up the search if you can't remember the digraph you're looking for. The search will allow you to fuzzy search by either digraph shortcut (OK for ✓) or official name ("CHECK MARK" for ✓).
# Adding or modifying digraphs
Adding or modifying digraphs can be done by setting the `vim.g.BetterDigraphsAdditions` variable
### Example
Modifying the `OK` (✓) digraph to be `*`, and adding a new `zz` digraph that maps to `Z`:
```lua
vim.g.BetterDigraphsAdditions = {
{
digraph = "OK",
symbol = "*",
name = "NEW STAR"
},
{
digraph = "zz",
symbol = "Z",
name = "CAPITAL Z"
}
}
```