Giter VIP home page Giter VIP logo

devdocs-web-ext's Introduction

logo

DevDocs Web Ext

Chrome Web Store Microsoft Edge Add-ons
users rating

Overview

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

popup search scope

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.

Chrome Web Store

Microsoft Edge

Visit Microsoft Edge Add-ons to install it.

Microsoft Edge Add-ons

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

devdocs-web-ext's People

Contributors

arianrhodsandlot avatar dependabot[bot] avatar kjelly avatar robinsimonklein avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar

Forkers

mba811 webcoding leeswagger kjelly skynetrmz manutepowa indigo7renegade robinsimonklein raylouis harveyrandall giangttd

devdocs-web-ext's Issues

Can't see documentations for enabled documentations

I am not able to view documentations for anything other than css and html. For example when I type unique_ptr it won't show any methods for cpp. I have tried enabling the documentation as the plugins instructs to, I deleted them the documentations, I tried allowing cookies for devdocs, I tried limited the extensions permissions on devdocs and giving full permissions, I've tried downloading the documentations offline, nothing seems to work. I am still a beginner, so I wouldn't have a clue as how to fix it it.

Can't subscribe on new docs

I'm add jQuery in devdocs.io, but nothing changed in quick devdocs library list(

P.S. Hmm, after downloading new docs (in "Offline" tab of devdocs) and reopening browser, new docs successfully loaded)

Add French translation

Title says it.

Creating the ticket here for the record; I'll fork, do it and PR as soon as I have some free time ;)

Syntax Highlighting

Syntax highlighting for the code snippets to match the ones on the website. Right now its just black and white
33b90f0b865cd53b52c9e3ec9331e1ec

Also the theme doesn't change to dark when set to dark.
251c6cb2f0733078ef261ccb26856f58

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.