https://github.com/mohamed3nan/devdocs-tab

An extension for Visual Studio Code to search for documentation on DevDocs.io faster by displaying it in a tab inside VS Code.
https://github.com/mohamed3nan/devdocs-tab

documentation vscode vscode-extension

Last synced: about 2 months ago
JSON representation

An extension for Visual Studio Code to search for documentation on DevDocs.io faster by displaying it in a tab inside VS Code.

• Host: GitHub
• URL: https://github.com/mohamed3nan/devdocs-tab
• Owner: Mohamed3nan
• License: mit
• Created: 2021-06-13T09:45:21.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-07-07T09:48:02.000Z (over 1 year ago)
• Last Synced: 2023-07-07T10:36:58.553Z (over 1 year ago)
• Topics: documentation, vscode, vscode-extension
• Language: JavaScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=Anan.devdocstab
• Size: 1.76 MB
• Stars: 29
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# VS Code - DevDocs Tab

 





[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/mohamed3nan/DevDocs-Tab)

[![Marketplace](https://vsmarketplacebadge.apphb.com/version/Anan.devdocstab.svg)](https://vsmarketplacebadge.apphb.com/version/Anan.devdocstab.svg)

[![Installs](https://vsmarketplacebadge.apphb.com/installs-short/Anan.devdocstab.svg)](https://vsmarketplacebadge.apphb.com/installs-short/Anan.devdocstab.svg)

[![Downloads](https://vsmarketplacebadge.apphb.com/downloads-short/Anan.devdocstab.svg)](https://vsmarketplacebadge.apphb.com/downloads-short/Anan.devdocstab.svg)

[![Rating](https://vsmarketplacebadge.apphb.com/rating-star/Anan.devdocstab.svg)](https://vsmarketplacebadge.apphb.com/rating-star/Anan.devdocstab.svg)

## Description

An extension for Visual Studio Code to 🔍search for documentation on DevDocs.io faster⚡️ by displaying it in a tab inside VS Code.

## Installation

Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.

```ext install anan.devdocstab```

or:

[Download from VisualStudio Marketplace](https://marketplace.visualstudio.com/items?itemName=Anan.devdocstab)

## Screenshot

![ScreenShot](./images/ScreenShot.gif)

## Features

The extension search your selected text from the current active file in DevDocs.io by using shortcut or by using mouse>Right-Click>"DevDocsTab: Search in DevDocs.io". Also a convenient `DevDocsTab` command could be used via command palette.

## Commands

Name                   | Description                              | Keybindings

--------------------   | ---------------------------------------  | ------------

DevDocsTab.home        | Open DevDocs Home Page                   | 

DevDocsTab.search      | Search DevDocs with the selected words   | `ctrl+k ctrl+k`

DevDocsTab.preferences | Open DevDocs Docs/Settings Page          |

DevDocsTab.offline     | Open DevDocs Offline Documentation 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 `DevDocsTab.preferences` You can choose enabled DOCS, choose theme, and general preferences.

* Run `DevDocsTab.offline` to cache documentations locally.

## Contribution

Feel free to make a pull request or open a new issue.

## Changelog

[CHANGELOG](CHANGELOG.md)

## License

This project is licensed under the MIT License - see the

[MIT](LICENSE.txt) file for details.

---

**Enjoy!**