• Stars
    star
    282
  • Rank 146,549 (Top 3 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created almost 9 years ago
  • Updated 6 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Dash, Zeal and Velocity documentation integration in Visual Studio Code 🔎📖

Visual Studio Code Dash

Dash documentation integration for Visual Studio Code

Dash is an API Documentation Browser and Code Snippet Manager for MacOS

Also support Zeal and Velocity.

Build Status Coverage Status All Contributors

vscode dash

Installation

Type cmd + shift + p to launch command palette and choose Extensions: Install Extension. Search this package and install.

Usage

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.

No need to select the text:

  • Pressing ctrl + shift + h. It will open dash with current file's docset.
  • Pressing alt + h. It will open dash with custom string and current file's docset.

Supported Docsets

This plugin supports almost all docset configuration based on Dash Mapping

Language to docset matching

This plugin supports language to docset mapping.

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
Ansible ansible dash.languageIdToDocsetMap.ansible, dash.languageIdToDocsetMap.ansible-advanced link
C++ cpp,net,boost,qt,cvcpp,cocos2dx,c,manpages dash.languageIdToDocsetMap.cpp link
C# net,mono,unity3d dash.languageIdToDocsetMap.csharp
Clojure clojure dash.languageIdToDocsetMap.clojure
Cmake cmake dash.languageIdToDocsetMap.cmake link
CoffeeScript coffee dash.languageIdToDocsetMap.coffee
CSS css,bootstrap,foundation,less,awesome,
cordova,phonegap
dash.languageIdToDocsetMap.css
Dart dartlang,polymerdart,angulardart dash.languageIdToDocsetMap.dart link
Elixir elixir dash.languageIdToDocsetMap.elixir link
Erlang erlang dash.languageIdToDocsetMap.erlang
Go go,godoc dash.languageIdToDocsetMap.go link
Gradle gradle dash.languageIdToDocsetMap.gradle link
Haskell haskell dash.languageIdToDocsetMap.haskell
Haml haml dash.languageIdToDocsetMap.haml link
Haxe haxe dash.languageIdToDocsetMap.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.languageIdToDocsetMap.html
Jade jade dash.languageIdToDocsetMap.jade
Java java,javafx,grails,groovy,playjava,spring,
cvj,processing
dash.languageIdToDocsetMap.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.languageIdToDocsetMap.javascript
Julia julia dash.languageIdToDocsetMap.julia link
Kotlin androidktx,kotlin dash.languageIdToDocsetMap.kotlin link
Latex latex dash.languageIdToDocsetMap.latex link
Less less dash.languageIdToDocsetMap.less
Lua lua,corona dash.languageIdToDocsetMap.lua link
Markdown markdown dash.languageIdToDocsetMap.markdown
Objective-C iphoneos,macosx,watchos,tvos,
appledoc,cocos2d,cocos3d,
kobold2d,sparrow,c,manpages
dash.languageIdToDocsetMap.objective-c
Perl perl,manpages dash.languageIdToDocsetMap.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.languageIdToDocsetMap.php
Processing processing dash.languageIdToDocsetMap.pde link
Puppet puppet dash.languageIdToDocsetMap.puppet link
Python python,django,twisted,sphinx,flask,tornado,
sqlalchemy,numpy,scipy,salt,pandas,matplotlib,cvp
dash.languageIdToDocsetMap.python link
R r dash.languageIdToDocsetMap.r
Ruby ruby,rubygems,rails dash.languageIdToDocsetMap.ruby link
Rust rust dash.languageIdToDocsetMap.rust link
Sass sass,compass,bourbon,neat,susy,css dash.languageIdToDocsetMap.sass
Scala scala,akka,playscala dash.languageIdToDocsetMap.scala
Shell Scripts bash,manpages dash.languageIdToDocsetMap.shellscript
SQL mysql,sqlite,psql dash.languageIdToDocsetMap.sql
Stylus stylus dash.languageIdToDocsetMap.stylus link
Swift swift,iphoneos,macosx,watchos,tvos,appledoc dash.languageIdToDocsetMap.swift link
Tcl tcl dash.languageIdToDocsetMap.tcl link
Terraform terraform dash.languageIdToDocsetMap.terraform link
TypeScript typescript dash.languageIdToDocsetMap.typescript
YAML chef,ansible dash.languageIdToDocsetMap.yaml

Added docset in this plugin

Language Dash Docset Keys Docset Setting Language Plugin
Elm elm dash.languageIdToDocsetMap.elm link
React react dash.languageIdToDocsetMap.javascriptreact link

File name to docset matching

This plugin also supports file name matching to docset, this is useful to target docset for any specific file name such as docker.yml or vagrantfile.

NOTE: You can use glob pattern to define the file name

File Name Dash Docset Keys Docset Setting
[dD]ocker* docker dash.fileNameToDocsetMap["docker.yml"]
vagrantfile vagrant dash.fileNameToDocsetMap["vagrantfile"]
gruntfile.js grunt dash.fileNameToDocsetMap["gruntfile.js"]
gulpfile.js gulp dash.fileNameToDocsetMap["gulpfile.js"]
*.ino arduino dash.fileNameToDocsetMap["*.ino"]

What is Dash Docset Keys?

You can find dash docset key in Dash application.

dash docset key

Change Docset Configuration

You can change docset in settings.json or pressing cmd + ,. Every configuration start with dash.docset. See Docset Setting column in Supported Docset table above.

Example Case:

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 able 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.languageIdToDocsetMap": {
  ...,
  "typescript": [
    "typescript",
    "javascript" // we add new dash docset key here
  ]
  ...
}

Change Keyboard Shortcut

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 selection in corresponding docset
{ "key": "your_shortcut", "command": "extension.dash.all" } // search in all docset
{ "key": "your_shortcut", "command": "extension.dash.emptySyntax" } // open dash with current file's docset open
{ "key": "your_shortcut", "command": "extension.dash.searchSyntax" } // open dash with custom string and current file's docset

Contributors

Thank you for these awesome contributors

Budi Irawan
Budi Irawan

💻 📖
Dima Granetchi
Dima Granetchi

💻 📖
Logan Saso
Logan Saso

💻 📖
Zhongren Shao
Zhongren Shao

💻 📖
dingweifeng
dingweifeng

📖
Seth Bromberger
Seth Bromberger

💻 📖
br1anchen
br1anchen

💻
Won Kim
Won Kim

💻
Cuyler Stuwe
Cuyler Stuwe

💻
Cahya Pribadi
Cahya Pribadi

💻
Marko Kajzer
Marko Kajzer

💻
akdir
akdir

💻

License

MIT © Budi Irawan

More Repositories

1

yii2-advanced-api

Yii2 advanced template with RESTful API setup
PHP
191
star
2

vscode-faker

Generating fake data in VS Code using Faker
TypeScript
64
star
3

react-native-fitness-app

React Native Fitness App
JavaScript
28
star
4

vscode-hasher

Generate various hash (md5, sha1), HTML entity conversion and many more for Visual Studio Code
TypeScript
9
star
5

vscode-hapijs-snippets

Hapi.js Snippets for Visual Studio Code
7
star
6

react-native-flashcard-app

Flashcard app made by React Native
JavaScript
6
star
7

alfred-material-themes

🌈 Material Themes for Alfred
6
star
8

docker-yii2-ci

Base image for Yii2 in Continuous Integration (CI) environment
6
star
9

fiscal-year

Library to deal with fiscal year
TypeScript
5
star
10

covid-19-stats

Chrome extension to display Covid-19 stats worldwide and per country
TypeScript
4
star
11

angular-nightwatch-demo

Angular 5 + Nightwatch setup
TypeScript
3
star
12

vscode-material2-snippets

Snippets for Angular Material 2
3
star
13

react-readable

React Redux application to manage posts and comments
JavaScript
3
star
14

storybook-github-pages-example

Deploy Storybook to Github pages
JavaScript
3
star
15

node-amazon-ses-example

An example of sending email using Amazon SES
JavaScript
3
star
16

kue-prom

Promotheus metrics for Kue
JavaScript
3
star
17

playsoundios

Playing Sound iOS using Swift Example
Swift
2
star
18

make-pretty

Setup prettier and its precommit hook for your project
TypeScript
2
star
19

vscode-elasticsearch-snippets

Snippets for Elasticsearch queries and aggregations
2
star
20

multi-file-swagger-ui

Example of How to generate Swagger UI based on multiple YAML files
TypeScript
2
star
21

node-elasticsearch-project

A sample Node.js project that use Elasticsearch
JavaScript
2
star
22

mutation-observer-storybook

A repo to reproduce mutation observer issue in Storybook
TypeScript
1
star
23

retwis-nodejs

Redis Twitter Clone using Node JS
JavaScript
1
star
24

express-typescript-example

Express JS in Typescript
1
star
25

learning-es6

My Learning Journey to Improve my ES6
HTML
1
star
26

testing-code-labs

My experiment repository for playing with testing related stuff
JavaScript
1
star
27

react-meals

JavaScript
1
star
28

atom-material2-snippets

Material 2 Snippets for Atom Text Editor
CoffeeScript
1
star
29

dotfiles

My Dotfiles
Shell
1
star
30

angular2-phonecat

Phonecat Application in Angular 2
TypeScript
1
star
31

material-kue-ui

Material UI for Kue
TypeScript
1
star
32

learning-golang

Go
1
star
33

library-api

Library API
JavaScript
1
star
34

deerawan

1
star
35

learning-react

JavaScript
1
star
36

doyan-ngoding-rxjs

Buku Doyan Ngoding RxJS
1
star
37

async-await-example

Async and ewait examples
JavaScript
1
star
38

nodeschool-solutions

Solutions to some node school lessons
JavaScript
1
star
39

intelliter

Setup Intellij IDEA command line formatter
TypeScript
1
star
40

budiirawan.com

CSS
1
star
41

lit-starter-storybook

JavaScript
1
star
42

css-code-labs

My experiment and coding stuff regarding CSS
HTML
1
star
43

hackerrank-solution

My codes to play with Hacker Rank
Ruby
1
star
44

jest-playground

My Jest playground
TypeScript
1
star
45

react-myreads

React application to manage books
JavaScript
1
star
46

love-angular2

A bookmark to articles, books, videos and plugins of Angular 2
1
star
47

angular-tour-of-heroes-app

TypeScript
1
star
48

react-chat

JavaScript
1
star
49

angular-hello-world

TypeScript
1
star
50

awesome-vscode

Curated List of resources, tutorial, tips related to Visual Studio Code
1
star