https://github.com/artbit/vim-zealdash

Vim plugin to register Zeal (Dash on OSX) as a keyword program
https://github.com/artbit/vim-zealdash

dash plugin vim zeal zealdocs

Last synced: 19 days ago
JSON representation

Vim plugin to register Zeal (Dash on OSX) as a keyword program

• Host: GitHub
• URL: https://github.com/artbit/vim-zealdash
• Owner: ArtBIT
• License: mit
• Created: 2017-09-14T15:56:30.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-09-14T18:59:17.000Z (almost 9 years ago)
• Last Synced: 2026-05-20T03:15:34.867Z (28 days ago)
• Topics: dash, plugin, vim, zeal, zealdocs
• Language: Vim script
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
[![GitHub stars](https://img.shields.io/github/stars/ArtBIT/vim-zealdash.svg)](https://github.com/ArtBIT/vim-zealdash) [![GitHub license](https://img.shields.io/github/license/ArtBIT/vim-zealdash.svg)](https://github.com/ArtBIT/vim-zealdash) [![GitHub issues](https://img.shields.io/github/issues/ArtBIT/vim-zealdash.svg)](https://github.com/ArtBIT/vim-zealdash/issues)

# Simple Zeal/Dash keyword lookup

This is a simple plug-in for Vim (and NeoVim) allowing to bind Vim's

builtin keyword lookup capabilities to an external program, namely [Zeal](http://https://zealdocs.org/)

(on GNU Linux) and [Dash](https://kapeli.com/dash) (on OSX).

## Installation

The easiest way to install the plugin is to install it as a bundle.

For example, using [Pathogen](https://github.com/tpope/vim-pathogen):

1. Get and install [pathogen.vim](https://github.com/tpope/vim-pathogen). You can skip this step

   if you already have it installed.

2. `cd ~/.vim/bundle`

3. `git clone git://github.com/artbit/vim-zealdash.git`

Bundle installs are known to work fine also when using [Vundle](https://github.com/gmarik/vundle). Other

bundle managers are expected to work as well.

:warning: If you use [Fish](http://fishshell.com/) as your shell, you *will* need to add

   `set shell=/bin/sh` to your `~/.vimrc` — the plugin relies on the

   setting pointing to a [Bourne-compatible](https://en.wikipedia.org/wiki/Bourne_shell) shell.

## Documentation

The documentation can be browsed directly in Vim::

    :help zealdash.txt

Alternatively, you can also [read it in your browser](doc/zealdash.txt)

## Updating

### Manually

In order to update the plugin, go to its bundle directory and use

Git to update it:

1. `cd ~/.vim/bundle/vim-zealdash`

2. `git pull`

### With Vundle

Use the `:BundleUpdate` command provided by Vundle, for example invoking

Vim like this:

  `$ vim +BundleUpdate`

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details