Dash documentation integration for Visual Studio Code
Dash is an API Documentation Browser and Code Snippet Manager for MacOS
Type cmd + shift + p to launch command palette and choose Extensions: Install Extension. Search this package and install.
Get the text under your cursor or selected first.
- Pressing
ctrl + h. It will search for current specific documentation depends on language. - Pressing
ctrl + alt + h. It will search for all documentation.
This plugin supports almost all docset configuration based on Dash Mapping
NOTE
For other languages that are not supported by default in VS Code, you probably need to install language plugins first in order to allow VS Code to detect the language.
| Language | Dash Docset Keys | Docset Setting | Language Plugin |
|---|---|---|---|
| C++ | cpp,net,boost,qt,cvcpp,cocos2dx,c,manpages | dash.docset.cpp | link |
| C# | net,mono,unity3d | dash.docset.csharp | |
| Clojure | clojure | dash.docset.clojure | |
| CoffeeScript | coffee | dash.docset.coffee | |
| CSS | css,bootstrap,foundation,less,awesome, cordova,phonegap |
dash.docset.css | |
| Dart | dartlang,polymerdart,angulardart | dash.docset.dart | link |
| Elixir | elixir | dash.docset.elixir | link |
| Erlang | erlang | dash.docset.erlang | |
| Go | go,godoc | dash.docset.go | link |
| Haskell | haskell | dash.docset.haskell | |
| Haxe | haxe | dash.docset.haxe | link |
| HTML | html,svg,css,bootstrap,foundation, awesome,statamic,javascript,jquery,jqueryui, jquerym,angularjs,backbone,marionette, meteor,moo,prototype,ember,lodash, underscore,sencha,extjs,knockout, zepto,cordova,phonegap,yui |
dash.docset.html | |
| Jade | jade | dash.docset.jade | |
| Java | java,javafx,grails,groovy,playjava,spring, cvj,processing |
dash.docset.java | link |
| JavaScript | javascript,jquery,jqueryui,jquerym,react, angularjs,backbone,marionette,meteor, sproutcore,moo,prototype,bootstrap, foundation,lodash,underscore,ember, sencha,extjs,titanium,knockout,zepto, yui,d3,svg,dojo,coffee,nodejs,express, grunt,mongoose,moment,require, awsjs,jasmine,sails,sinon,chai, html,css,cordova,phonegap,unity3d |
dash.docset.javascript | |
| Less | less | dash.docset.less | |
| Lua | lua,corona | dash.docset.lua | link |
| Markdown | markdown | dash.docset.markdown | |
| Objective-C | iphoneos,macosx,watchos,tvos, appledoc,cocos2d,cocos3d, kobold2d,sparrow,c,manpages |
dash.docset.objective-c | |
| Perl | perl,manpages | dash.docset.perl | |
| PHP | php,wordpress,drupal,zend,laravel,yii,joomla,ee, codeigniter,cakephp,phpunit,symfony,typo3, twig,smarty,craft,phpp,html,statamic,mysql, sqlite,mongodb,psql,redis |
dash.docset.php | |
| Processing | processing | dash.docset.pde | link |
| Puppet | puppet | dash.docset.puppet | link |
| Python | python,django,twisted,sphinx,flask,tornado, sqlalchemy,numpy,scipy,salt,pandas,matplotlib,cvp |
dash.docset.python | link |
| R | r | dash.docset.r | |
| Ruby | ruby,rubygems,rails | dash.docset.ruby | link |
| Rust | rust | dash.docset.rust | link |
| Sass | sass,compass,bourbon,neat,susy,css | dash.docset.sass | |
| Scala | scala,akka,playscala | dash.docset.scala | |
| Shell Scripts | bash,manpages | dash.docset.shellscript | |
| SQL | mysql,sqlite,psql | dash.docset.sql | |
| Stylus | stylus | dash.docset.stylus | link |
| Swift | swift,iphoneos,macosx,watchos,tvos,appledoc | dash.docset.swift | link |
| Tcl | tcl | dash.docset.tcl | link |
| TypeScript | typescript | dash.docset.typescript | |
| YAML | chef,ansible | dash.docset.yaml |
| Language | Dash Docset Keys | Docset Setting | Language Plugin |
|---|---|---|---|
| Elm | elm | dash.docset.elm | link |
| React | react | dash.docset.javascriptreact | link |
You can find dash docset key in Dash application.
You can change docset in settings.json or pressing cmd + ,.
Every configuration start with dash.docset. See Docset Setting in Supported Docset table above.
Based on default docset configuration, if we search in typescript files (.ts), it will search in typescript docset. But now we want to make it to search in javascript docset too.
Type cmd + , then we change typescript docset by adding new dash docset key "javascript". So, whenever we search from typescript files, it will search in typescript and javascript docset.
The result will look like below:
// settings.json, add lines below
"dash.docset.typescript": [
"typescript",
"javascript" // we add new dash docset key here
]
You can bind default shortcut to another shortcut keys
Choose in top menu Code -> Preferences -> Keyboard Shortcuts or using shortcuts cmd + K, cmd + S
Add one or two lines below
{ "key": "your_shortcut", "command": "extension.dash.specific" }, // search in specific docset
{ "key": "your_shortcut", "command": "extension.dash.all" } // search in all docsetMIT