Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Atom Dash

Build status

Simple Dash documentation integration for Atom.

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:

'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 and built-in filename map for the default configurations.

License

MIT

You can’t perform that action at this time.