https://github.com/arianrhodsandlot/devdocs-web-ext
A browser extension for DevDocs.
https://github.com/arianrhodsandlot/devdocs-web-ext
chrome-extension chrome-extensions devdocs documentation-tool web-extension web-extensions
Last synced: about 1 year ago
JSON representation
A browser extension for DevDocs.
- Host: GitHub
- URL: https://github.com/arianrhodsandlot/devdocs-web-ext
- Owner: arianrhodsandlot
- License: mit
- Created: 2015-04-19T14:23:10.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2024-01-24T11:10:00.000Z (over 2 years ago)
- Last Synced: 2024-01-24T12:33:50.293Z (over 2 years ago)
- Topics: chrome-extension, chrome-extensions, devdocs, documentation-tool, web-extension, web-extensions
- Language: TypeScript
- Homepage:
- Size: 5.81 MB
- Stars: 32
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license
Awesome Lists containing this project
README
DevDocs Web Ext
## Overview
DevDocs Web Ext is a browser extension that allows you to quickly search and browse online documentations from [DevDocs](https://devdocs.io).
## Features
+ Quick access to documentation for over 200 development libraries provided by [DevDocs](https://devdocs.io).
+ 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](https://chrome.google.com/webstore/detail/devdocs-web-ext/kdjoccdpjblcefijcfhnjoljodddedpj) to install it.
[](https://chrome.google.com/webstore/detail/devdocs-web-ext/kdjoccdpjblcefijcfhnjoljodddedpj)
### Microsoft Edge
Visit [Microsoft Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/devdocs-web-ext/dglcbgdedngbiaaohopncfonhdngodmo) to install it.
[](https://microsoftedge.microsoft.com/addons/detail/devdocs-web-ext/dglcbgdedngbiaaohopncfonhdngodmo)
## 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](https://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.
```sh
# 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](https://devdocs.io), an amazing website for developers. Thanks to [all the contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors) who make [DevDocs](https://devdocs.io) possible!
## License
[MIT](license)