vscode-devdocs README

November 16, 2017 ยท View on GitHub

WARNING: Due to restriction imposed by vscode.previewHtml, all preferences and offline data for DevDocs will be lost after VSCode restart. It is not recommended to use this extension any more.

Search documentation on devdocs.io inside VSCode

Commands

NameDescriptionKeybindings
devdocs.quickSearchSearch DevDocs with the word under cursor or selected wordsalt+shift+d
devdocs.searchSearch DevDocs with keywords
devdocs.homeOpen DevDocs home
devdocs.settingsOpen DevDocs settings page
devdocs.offlineOpen DevDocs offline data page

General Notes

This is a simple wrapper around devdocs.io. All documentations are provided and hosted by devdocs.io. The extension has no control over DevDocs. For best user experience, you should configure it manually:

  • Run devdocs.settings. You can choose enabled documents, use dark theme and/or hide sidebar as needed
  • Run devdocs.offline to cache documentations locally

For further information, please refer to DevDocs Help.

Extension Settings

This extension contributes the following setting:

"devdocs.column": {
    "type": "number",
    "default": 2,
    "description": "A number which indicates which column (1, 2, or 3) to display DevDocs in"
}

Known Issues

  • Document list in devdocs.settings page might be buggy (lose scroll position on first click)
  • All preferences and offline data for DevDocs will be lost after VSCode restart due to recent changes to vscode #4

Release Notes

1.0.0

Initial release