https://github.com/ivyl/highlight-annotate.nvim

neovim plugin for aiding reading and analyzing text files
https://github.com/ivyl/highlight-annotate.nvim

lua neovim neovim-plugin nvim nvim-plugin

Last synced: about 1 month ago
JSON representation

neovim plugin for aiding reading and analyzing text files

• Host: GitHub
• URL: https://github.com/ivyl/highlight-annotate.nvim
• Owner: ivyl
• License: mit
• Created: 2022-08-02T22:26:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-07T21:30:48.000Z (over 2 years ago)
• Last Synced: 2023-04-11T13:48:05.085Z (over 1 year ago)
• Topics: lua, neovim, neovim-plugin, nvim, nvim-plugin
• Language: Lua
• Homepage:
• Size: 15.6 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# highlight-annotate.nvim

Highlight-annotate.nvim is a plugin for aiding reading and analyzing text

files such as logs or program sources.

The [highlights](#highlight) and [annotations](#annotate) are not persistent

and last only for the current editing session.

## Install

[packer.nvim](https://github.com/wbthomason/packer.nvim):

```lua

use { 'ivyl/highlight-annotate.nvim', config = function()

  require'highlight-annotate'.setup({})

end }

```

## Docs

[`:help highlight-annotate.txt`](doc/highlight-annotate.txt)

## Highlight

Local to window.

`:HA hl`

![Preview](https://i.imgur.com/EhZEtev.gif)

`:HA list`

`:HA del-hl`

## Annotate

Local to buffer.

`:HA a`

![Preview](https://i.imgur.com/NjTHn6P.gif)

`:HA del-a`

## Search Annotations

Requires [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)

```lua

local telescope = require 'telescope'

-- regular telescope setup goes here

telescope.load_extension('highlight-annotate')

vim.keymap.set('n', 'fa', telescope.extensions["highlight-annotate"].annotations)

```

`:Telescope highlight-annotate annotations` or use the mapping.

![Preview](https://i.imgur.com/8RD9CXF.gif)