https://github.com/vimpostor/vim-clue

Documentation right at your fingertips
https://github.com/vimpostor/vim-clue

docs documentation neovim neovim-plugin nvim vim vim-plugin zeal

Last synced: 7 months ago
JSON representation

Documentation right at your fingertips

• Host: GitHub
• URL: https://github.com/vimpostor/vim-clue
• Owner: vimpostor
• License: gpl-3.0
• Created: 2024-08-24T21:30:32.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-09-28T21:37:29.000Z (over 1 year ago)
• Last Synced: 2024-09-29T06:02:48.666Z (over 1 year ago)
• Topics: docs, documentation, neovim, neovim-plugin, nvim, vim, vim-plugin, zeal
• Language: Vim Script
• Homepage:
• Size: 85 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# vim-clue

Documentation directly at your fingertips.

# Installation

Using **vim-plug**:

```vim

Plug 'vimpostor/vim-clue'

```

Additionally the following software dependencies are required to be installed:

- [zeal](https://zealdocs.org/)

- [sqlite](https://www.sqlite.org/)

- [pandoc](https://pandoc.org/)

- [elinks](https://github.com/rkd77/elinks)

 

![Screenshot](https://github.com/user-attachments/assets/2594f14e-0f84-4657-a0cb-ef5de66e1a0b)

# Usage

Press `F1` on any symbol to look it up directly inside Vim. The plugin will consult any Dash docsets that you have installed and will open the matching documentation in a popup by default. Alternatively other external programs can be used.

For more information consult the extensive help page under `:help clue-configure`.