{"id":16801982,"url":"https://github.com/shivaprsd/doqment","last_synced_at":"2025-09-25T14:24:34.335Z","repository":{"id":50148468,"uuid":"480988050","full_name":"shivaprsd/doqment","owner":"shivaprsd","description":"Mozilla's HTML5 PDF Viewer with Reader-mode add-on. 📖","archived":false,"fork":false,"pushed_at":"2025-08-07T11:05:51.000Z","size":5852,"stargazers_count":83,"open_issues_count":10,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-07T13:05:51.255Z","etag":null,"topics":["chrome-extension","dark-mode","doq","firefox-addon","pdf-reader","pdfjs","reader-mode","web-extension"],"latest_commit_sha":null,"homepage":"https://shivaprsd.github.io/doqment/src/pdfjs/web/viewer.html","language":"JavaScript","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/shivaprsd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-04-12T22:10:34.000Z","updated_at":"2025-08-04T23:37:30.000Z","dependencies_parsed_at":"2024-07-30T21:22:33.593Z","dependency_job_id":"f75195e5-ac30-41b0-929c-10465c3fd552","html_url":"https://github.com/shivaprsd/doqment","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/shivaprsd/doqment","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shivaprsd%2Fdoqment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shivaprsd%2Fdoqment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shivaprsd%2Fdoqment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shivaprsd%2Fdoqment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shivaprsd","download_url":"https://codeload.github.com/shivaprsd/doqment/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shivaprsd%2Fdoqment/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276930995,"owners_count":25730520,"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","status":"online","status_checked_at":"2025-09-25T02:00:09.612Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","dark-mode","doq","firefox-addon","pdf-reader","pdfjs","reader-mode","web-extension"],"created_at":"2024-10-13T09:38:22.373Z","updated_at":"2025-09-25T14:24:34.293Z","avatar_url":"https://github.com/shivaprsd.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![doqment icon](docs/logo.png)\n\n# doqment\n\n*doqment* (pronounced as *doc-HUE-ment*) is a custom deployment of the\n[PDF.js][1] generic viewer with [*doq*][2] reader mode add-on (that lets you\nchange the PDF's colors) on top, packaged as a Web Extension.\n\nIt also adds some other features like Smart Zoom text and Show/Hide toolbar to\noptimize space and assist reading, especially on smaller devices.\n\nHere is the demo PDF rendered in *Solarized Light* theme:\n\n![Screenshot of doqment running in Firefox](docs/grabs/solarized-light.png)\n\nView [more screenshots](docs/gallery.md#themes).\n\n## Installation\n\n[ ![Get for Firefox](docs/amo-badge.png) ][4] \u0026nbsp;\n[ ![Get for Chrome](docs/cws-badge.png) ][6]\n\nLatest release can be installed from [AMO][4] / [CWS][6], or downloaded from\n[Releases][5].\n\nIn Firefox, *doqment* replaces the built-in PDF.js viewer as the default PDF\nviewer application. In Chrome(ium), it co-exists with the native viewer, and\nprovides a context menu and toolbar button to open PDFs in it instead.\n\n#### Extension options\n\nPreferences for both the PDF.js viewer and *doq* can be configured through the\nextension options page (right click the toolbar icon and choose *Options* or\n*Manage Extension* -\u003e *Preferences*).\n\n#### Note for Firefox users:\n\nIt is recommended to disable the built-in viewer while this extension is\nenabled to avoid funny and weird behaviours while opening/downloading PDFs.\n(Go to *Settings* -\u003e *Files and Applications* -\u003e set the *Action* for PDF to\nsomething other than *Open in Firefox*).\n\n#### Note for Chrome(ium) users:\n\nThe extension can open PDF links via the context menu whether the native viewer\nis enabled or disabled. To always open PDFs in the browser without downloading\nthem first, keep it enabled. (Go to *Settings* -\u003e *Privacy and security* -\u003e\n*Site Settings* -\u003e *Additional content settings* (under *Content*) -\u003e\n*PDF documents*; or open `chrome://settings/content/pdfDocuments`).\n\n## Development\n\n**Note:** In Firefox, *doqment* uses Manifest Version 2, while in Chromiums it\nuses MV3.\n\n1. Clone this repo recursively (to get the submodules)\n2. Update the symlink to the correct manifest file:\n```\n$ cd src\n$ ln -sf manifest-v2.json manifest.json    # for Firefox (default)\n$ ln -sf manifest-v3.json manifest.json    # for Chrome, Edge, etc\n```\n3. Install unpacked via `about:debugging` / `chrome:extensions` (or using\n   `web-ext`)\n4. Hack to your heart's content and submit a PR!\n\n#### Packaging\n\nRun the `pack.sh` script **from the repo root**:\n```\n$ ./pack.sh [mv2|mv3]    # default is mv2\n```\n\n## Limitations\n\n### Firefox\n\nCompared with the viewer baked right into Firefox's code, an extension is a lot\nless previleged and hence, has certain limitations:\n\n1. Cannot load local files via the `file:` URL scheme. The user has to first\n   open the extension's viewer in a tab and use the viewer's UI to open them\n   (hence a browser toolbar button is provided for this).\n2. Cannot use the integrated Findbar to search for text in PDF.\n3. The address bar shows an ugly extension URL instead of the original PDF URL\n   (hence a popup is provided to quickly show the later).\n\n### Chromium\n\n1. Can open `file:` URLs, only if the user grants access in the extension's\n   settings.\n2. Redirecting links cannot be opened via the context menu; users will have to\n   first open it in the native viewer, and then use the toolbar button.\n\n## Rationale\n\nAs the built-in viewer of Firefox is a previleged page, extensions cannot\nmodify it. Thus a custom deployment is currently the only way to ship add-ons\nto the viewer (other than getting your patch merged into PDF.js).\n\nOn the plus side, this also enables users of other browsers to have PDF.js and\n*doq*.\n\nThis project can also be used as a boilerplate by anyone else wishing to\ndevelop their own awesome crazy add-on for the PDF.js viewer.\n\nFor the rationale behind reader mode see the [*doq* Readme][3].\n\nHappy PDF Reading!\n\n---\n\n[1]: https://mozilla.github.io/pdf.js/web/viewer.html\n[2]: https://github.com/shivaprsd/doq\n[3]: https://github.com/shivaprsd/doq#why-doq\n[4]: https://addons.mozilla.org/addon/doqment\n[5]: https://github.com/shivaprsd/doqment/releases/latest\n[6]: https://chrome.google.com/webstore/detail/ajmcpdllaaklaocodbnllhkaflncmlog\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshivaprsd%2Fdoqment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshivaprsd%2Fdoqment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshivaprsd%2Fdoqment/lists"}