https://github.com/samundrak/vscode-esdoc-mdn
[BETA] See documentation of any javascript api from mozilla on your visual studio code side by side
https://github.com/samundrak/vscode-esdoc-mdn
documentation mdn mozilla vscode vscode-extension
Last synced: about 1 year ago
JSON representation
[BETA] See documentation of any javascript api from mozilla on your visual studio code side by side
- Host: GitHub
- URL: https://github.com/samundrak/vscode-esdoc-mdn
- Owner: samundrak
- Created: 2018-02-28T19:15:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T16:48:03.000Z (over 3 years ago)
- Last Synced: 2025-03-30T18:44:01.175Z (about 1 year ago)
- Topics: documentation, mdn, mozilla, vscode, vscode-extension
- Language: JavaScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=samundrak.esdoc-mdn
- Size: 682 KB
- Stars: 33
- Watchers: 3
- Forks: 7
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Awesome plugin for Visual Studio Code :sunglasses: [Beta]
## Quickly see docs from MDN in VS Code
This extension lets you quickly bring up helpful MDN documentation in the editor by typing `//mdn [api];`. For example, to see documentation for `Object`, type `//mdn Object;`, and to view a method or property, such as `Object.assign`, type `//mdn Object.assign;`. Don't forget the semicolon!
## Usage
Load documentation of top level or global objects:
//mdn [api];
example: //mdn Array;
Load documentation of a method or property:
//mdn [api].[method];
example: //mdn Array.from;
`[api]` and `[method]` are case-insensitive, so `//mdn array.from;` is also fine.
### Is the semicolon necessary?
Yes! A search won't happen without it.
## Examples
```
//mdn document;
//mdn Object.keys;
//mdn object.values;
//mdn Array.slice;
//mdn array.splice;
```
## Supports
`js`, `vue`,`jsx`, `ts`,`tsx`