{"id":24632835,"url":"https://github.com/arianrhodsandlot/devdocs-web-ext","last_synced_at":"2025-05-08T03:21:11.535Z","repository":{"id":42185473,"uuid":"34209605","full_name":"arianrhodsandlot/devdocs-web-ext","owner":"arianrhodsandlot","description":"A browser extension for DevDocs.","archived":false,"fork":false,"pushed_at":"2024-01-24T11:10:00.000Z","size":6088,"stargazers_count":32,"open_issues_count":0,"forks_count":12,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-01-24T12:33:50.293Z","etag":null,"topics":["chrome-extension","chrome-extensions","devdocs","documentation-tool","web-extension","web-extensions"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arianrhodsandlot.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2015-04-19T14:23:10.000Z","updated_at":"2024-01-12T10:49:21.000Z","dependencies_parsed_at":"2023-01-31T08:16:07.666Z","dependency_job_id":"634cdf56-1d83-4c0f-8da6-abfa3f9326bb","html_url":"https://github.com/arianrhodsandlot/devdocs-web-ext","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arianrhodsandlot%2Fdevdocs-web-ext","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arianrhodsandlot%2Fdevdocs-web-ext/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arianrhodsandlot%2Fdevdocs-web-ext/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arianrhodsandlot%2Fdevdocs-web-ext/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arianrhodsandlot","download_url":"https://codeload.github.com/arianrhodsandlot/devdocs-web-ext/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235552901,"owners_count":19008490,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chrome-extension","chrome-extensions","devdocs","documentation-tool","web-extension","web-extensions"],"created_at":"2025-01-25T08:13:09.793Z","updated_at":"2025-01-25T08:13:10.179Z","avatar_url":"https://github.com/arianrhodsandlot.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./docs/images/brandings/logo.png\" alt=\"logo\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eDevDocs Web Ext\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://chrome.google.com/webstore/detail/devdocs-web-ext/kdjoccdpjblcefijcfhnjoljodddedpj\"\u003e\n    \u003cimg src=\"https://img.shields.io/chrome-web-store/v/kdjoccdpjblcefijcfhnjoljodddedpj.svg\" alt=\"Chrome Web Store\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://microsoftedge.microsoft.com/addons/detail/devdocs-web-ext/dglcbgdedngbiaaohopncfonhdngodmo\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/dynamic/json?label=edge%20add-on\u0026prefix=v\u0026query=%24.version\u0026url=https%3A%2F%2Fmicrosoftedge.microsoft.com%2Faddons%2Fgetproductdetailsbycrxid%2Fdglcbgdedngbiaaohopncfonhdngodmo\" alt=\"Microsoft Edge Add-ons\"\u003e\n  \u003c/a\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://chrome.google.com/webstore/detail/devdocs-web-ext/kdjoccdpjblcefijcfhnjoljodddedpj\"\u003e\n    \u003cimg src=\"https://img.shields.io/chrome-web-store/users/kdjoccdpjblcefijcfhnjoljodddedpj.svg\" alt=\"users\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://chrome.google.com/webstore/detail/devdocs-web-ext/kdjoccdpjblcefijcfhnjoljodddedpj\"\u003e\n    \u003cimg src=\"https://img.shields.io/chrome-web-store/stars/kdjoccdpjblcefijcfhnjoljodddedpj.svg\" alt=\"rating\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Overview\nDevDocs Web Ext is a browser extension that allows you to quickly search and browse online documentations from [DevDocs](https://devdocs.io).\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src='./docs/images/screenshots/popup-doc.png' width='600' alt=\"popup search scope\" /\u003e\n\u003c/p\u003e\n\n## Features\n+ Quick access to documentation for over 200 development libraries provided by [DevDocs](https://devdocs.io).\n+ Search in a certain library or a certain version of the library.\n+ Dark theme is supported.\n\n## Install\n### Google Chrome / Chromium based browsers (Vivaldi, Brave, etc.)\nVisit [Chrome Web Store](https://chrome.google.com/webstore/detail/devdocs-web-ext/kdjoccdpjblcefijcfhnjoljodddedpj) to install it.\n\n[![Chrome Web Store](https://storage.googleapis.com/web-dev-uploads/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/UV4C4ybeBTsZt43U4xis.png)](https://chrome.google.com/webstore/detail/devdocs-web-ext/kdjoccdpjblcefijcfhnjoljodddedpj)\n\n### Microsoft Edge\nVisit [Microsoft Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/devdocs-web-ext/dglcbgdedngbiaaohopncfonhdngodmo) to install it.\n\n[![Microsoft Edge Add-ons](https://user-images.githubusercontent.com/72879799/229780441-610f727a-edb4-41e0-a1fb-6593af3d4485.svg)](https://microsoftedge.microsoft.com/addons/detail/devdocs-web-ext/dglcbgdedngbiaaohopncfonhdngodmo)\n\n## Usage\nTo 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: \u003ckbd\u003eALT\u003c/kbd\u003e + \u003ckbd\u003eS\u003c/kbd\u003e.\n\nYou can also click open the options page to customize the extension's behavior, including changing your appearance and theme.\n\n## Screenshots\nScreenshots are captured using Google Chrome.\n| Description | Screenshot |\n|---|---|\n| Open the extension | \u003cimg src=\"./docs/images/screenshots/popup.png\" width=\"320\" height=\"200\"\u003e |\n| Dark mode | \u003cimg src=\"./docs/images/screenshots/popup-dark.png\" width=\"320\" height=\"200\"\u003e |\n| Search | \u003cimg src=\"./docs/images/screenshots/popup-search.png\" width=\"320\" height=\"200\"\u003e |\n| Press \u003ckbd\u003eTab\u003c/kbd\u003e to select a certain documentation, \u003cbr\u003e then search in this documentation | \u003cimg src=\"./docs/images/screenshots/popup-search-scope.png\" width=\"320\" height=\"200\"\u003e |\n| Select a new documentation in [devdocs.io](https://devdocs.io) | \u003cimg src=\"./docs/images/screenshots/popup-new-scope.png\" width=\"320\" height=\"200\"\u003e |\n| Read an article from the documentation | \u003cimg src=\"./docs/images/screenshots/popup-doc.png\" width=\"320\" height=\"200\"\u003e |\n| Read an article in dark mode | \u003cimg src=\"./docs/images/screenshots/popup-doc-dark.png\" width=\"320\" height=\"200\"\u003e |\n\n## Contributing\nDevDocs 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.\n\n## Development\n\nHere is a simple overview about how to set up development environment.\n```sh\n# initialize the development environment\ngit clone https://github.com/arianrhodsandlot/devdocs-web-ext.git\ncd devdocs-web-ext\npnpm i\n\n# start a fresh browser using Playwright with the develop version extension installed\npnpm dev\n\n# run test cases locally\npnpm t\n\n# debug test cases\n# see https://playwright.dev/docs/debug#run-in-debug-mode-1 for more information about Playwright\npnpm playwright test -c tests --debug\n# or debug using Playwright's Browser Developer Tools\n# see https://playwright.dev/docs/debug#browser-developer-tools\nPWDEBUG=console pnpm playwright test -c tests\n```\n\n## Credits\nDevDocs 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!\n\n## License\n\n[MIT](license)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farianrhodsandlot%2Fdevdocs-web-ext","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farianrhodsandlot%2Fdevdocs-web-ext","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farianrhodsandlot%2Fdevdocs-web-ext/lists"}