DevDocs Web Ext

Overview

DevDocs Web Ext is a browser extension that allows you to quickly search and browse online documentations from DevDocs.

Features

• Quick access to documentation for over 200 development libraries provided by DevDocs.
• Search in a certain library or a certain version of the library.
• Dark theme is supported.

Install

Google Chrome / Chromium based browsers (Vivaldi, Brave, etc.)

Visit Chrome Web Store to install it.

Microsoft Edge

Visit Microsoft Edge Add-ons to install it.

Usage

To use DevDocs Web Ext, simply click on the extension icon in your browser's toolbar to open the popup window. From there, you can search for the library you need and browse through its documentation. There is also a default shortcut for opening the popup window: ALT + S.

You can also click open the options page to customize the extension's behavior, including changing your appearance and theme.

Screenshots

Screenshots are captured using Google Chrome. | Description | Screenshot | |---|---| | Open the extension | | | Dark mode | | | Search | | | Press Tab to select a certain documentation,

then search in this documentation | | | Select a new documentation in devdocs.io | | | Read an article from the documentation | | | Read an article in dark mode | |

Contributing

DevDocs Web Ext is an open-source project, and contributions are always welcome! If you have an idea for a new feature, find a bug, or just want to help out, feel free to submit a pull request or open an issue on our GitHub page.

Development

Here is a simple overview about how to set up development environment.

# initialize the development environment
git clone https://github.com/arianrhodsandlot/devdocs-web-ext.git
cd devdocs-web-ext
pnpm i

# start a fresh browser using Playwright with the develop version extension installed
pnpm dev

# run test cases locally
pnpm t

# debug test cases
# see https://playwright.dev/docs/debug#run-in-debug-mode-1 for more information about Playwright
pnpm playwright test -c tests --debug
# or debug using Playwright's Browser Developer Tools
# see https://playwright.dev/docs/debug#browser-developer-tools
PWDEBUG=console pnpm playwright test -c tests

Credits

DevDocs Web Ext is built on top of DevDocs, an amazing website for developers. Thanks to all the contributors who make DevDocs possible!

License

MIT