https://github.com/blakeembrey/atom-dash

Dash documentation integration with Atom
https://github.com/blakeembrey/atom-dash

atom atom-dash dash docset documentation zeal

Last synced: 1 day ago
JSON representation

Dash documentation integration with Atom

• Host: GitHub
• URL: https://github.com/blakeembrey/atom-dash
• Owner: blakeembrey
• License: mit
• Created: 2014-03-06T15:17:38.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2019-06-12T21:19:46.000Z (over 5 years ago)
• Last Synced: 2025-01-13T18:15:19.689Z (9 days ago)
• Topics: atom, atom-dash, dash, docset, documentation, zeal
• Language: CoffeeScript
• Size: 58.6 KB
• Stars: 394
• Watchers: 16
• Forks: 26
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Atom Dash

[![Build status][travis-image]][travis-url]

> Simple [Dash](http://kapeli.com/dash) documentation integration for [Atom](https://atom.io/packages/dash).

**Please note:** This plugin also works with Velocity or Zeal on Windows, and Zeal on Linux.

## Installation

```

apm install dash

```

Alternatively, open `Settings/Preferences -> Install` and search for `dash`.

## Usage

Look up the word under your cursor or selected text by pressing `ctrl-h`. This uses a scoped search and searches based on the current file name and selected syntax. If you want to search all documentation, press `ctrl-alt-h`.

**Hint:** To look up a word without bringing Dash to the front, add `shift` to the command. E.g. `ctrl-shift-h`. This is useful when Dash is already visible - such as on a dual monitor setup.

### Adding Docsets

Open the Atom config file `Atom -> Config...` and add the docsets under the `dash` object in the following form:

```cson

'dash':

  'grammars':

    'JavaScript': [

      'nodejs'

    ]

  'filenames':

    'gruntfile.js': [

      'grunt'

    ]

```

**Please note:** File names _must_ be lower case.

Docsets defined in your local configuration will override the default settings. Take a look at the [built-in grammar map](https://github.com/blakeembrey/atom-dash/blob/master/lib/grammar-map.coffee) and [built-in filename map](https://github.com/blakeembrey/atom-dash/blob/master/lib/filename-map.coffee) for the default configurations.

## License

MIT

[travis-image]: https://img.shields.io/travis/blakeembrey/atom-dash.svg?style=flat

[travis-url]: https://travis-ci.org/blakeembrey/atom-dash