{"id":13412306,"url":"https://github.com/dteoh/devdocs-macos","last_synced_at":"2025-04-05T16:07:38.094Z","repository":{"id":34806432,"uuid":"163154702","full_name":"dteoh/devdocs-macos","owner":"dteoh","description":"An unofficial DevDocs API Documentation viewer for macOS.","archived":false,"fork":false,"pushed_at":"2023-03-04T04:36:45.000Z","size":10619,"stargazers_count":457,"open_issues_count":3,"forks_count":18,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-07-31T20:50:10.450Z","etag":null,"topics":["desktop-app","devdocs","developer-tools","documentation","documentation-tool","macos","productivity"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dteoh.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}},"created_at":"2018-12-26T08:14:14.000Z","updated_at":"2024-07-26T18:09:55.000Z","dependencies_parsed_at":"2024-01-02T21:56:21.331Z","dependency_job_id":"5c037167-7282-403f-b0e2-0de1db5c6bd6","html_url":"https://github.com/dteoh/devdocs-macos","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dteoh%2Fdevdocs-macos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dteoh%2Fdevdocs-macos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dteoh%2Fdevdocs-macos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dteoh%2Fdevdocs-macos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dteoh","download_url":"https://codeload.github.com/dteoh/devdocs-macos/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361687,"owners_count":20926643,"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":["desktop-app","devdocs","developer-tools","documentation","documentation-tool","macos","productivity"],"created_at":"2024-07-30T20:01:23.252Z","updated_at":"2025-04-05T16:07:38.046Z","avatar_url":"https://github.com/dteoh.png","language":"Swift","readme":"# DevDocs for macOS\n\n[![Release](https://img.shields.io/github/release/dteoh/devdocs-macos.svg)](https://github.com/dteoh/devdocs-macos/releases)\n![Release Date](https://img.shields.io/github/release-date/dteoh/devdocs-macos.svg)\n\nAn unofficial [DevDocs API Documentation][1] viewer for macOS.\n\n![App screenshot](./img/screenshot.png?raw=true \"DevDocs for macOS screenshot\")\n\n## Features\n\n- [x] Tabs\n- [x] Global shortcut (\u003ckbd\u003eOption + Space\u003c/kbd\u003e), customizable\n- [x] Automatic dark/light mode UI\n- [x] Protocol handler integration (handle `devdocs-macos://`, `http://`, and `https://` URLs)\n- [x] Page search (\u003ckbd\u003eCmd + F\u003c/kbd\u003e)\n\n### Protocol handler integration\n\nProtocol handler integration allows you to control DevDocs through scripts. For\nexample:\n\n```\n$ osascript -e 'tell application \"DevDocs\" to open location \"devdocs-macos://search?doc=rails\u0026term=stro\"'\n```\n\n... will tell DevDocs to open a new window and search the Rails documentation for\nthe term `stro`.\n\nThe app supports the following commands. When required parameters are not\nsupplied, the command is ignored.\n\n#### `devdocs-macos://search`\n\nThis is for launching a search query in a new window.\n\n| Query Parameter | Required | Description\n| --------------- | -------- | -----------\n| term            | Yes      | The search term, eg. `stro`\n| doc             | No       | Documentation scope, eg. `rails`\n\n#### `devdocs-macos://newWindow`\n\nThis opens a new window.\n\n#### `http://` and `https://`\n\nDevDocs will open a new window only for URLs on the `devdocs.io` domain. For\nexample:\n\n```\n$ osascript -e 'tell application \"DevDocs\" to open location \"https://devdocs.io/#q=rails+stro\"'\n```\n\nOther domains are ignored.\n\n## Download \u0026 Install\n\nPre-built binaries can be downloaded from the [releases page][2].\n\nUnzip, drag the app to Applications, and then run it.\n\n### Homebrew\n\nIf you wish to install the application from Homebrew:\n\n```\n$ brew install --cask dteoh-devdocs\n```\n\nThe application will live at `/Applications/DevDocs.app`.\n\n#### Migrating from project tap to the default tap\n\nThe application had a tap maintained by the project. To migrate to the default\ntap:\n\n```\n$ brew cask uninstall devdocs-macos\n$ brew untap dteoh/devdocs\n$ brew cask install dteoh-devdocs\n```\n\n### Compatibility\n\nThe app is currently developed on Big Sur and only support for Big Sur\ncan be provided.\n\nIf you are using Mojave (10.14) or Catalina (10.15), please use version 0.5.2.\n\n## License\n\n```\nDevDocs for macOS\n\nCopyright (C) 2021 Douglas Teoh\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n```\n\n### App Icon\n\nThe app icon is a contribution courtesy of [@mickimnet][3] ([#1][4], [#42][5]).\n\n\n[1]: https://devdocs.io/\n[2]: https://github.com/dteoh/devdocs-macos/releases\n[3]: https://github.com/mickimnet\n[4]: https://github.com/dteoh/devdocs-macos/issues/1\n[5]: https://github.com/dteoh/devdocs-macos/pull/42\n","funding_links":[],"categories":["Swift","Applications","Other"],"sub_categories":["Other","Text","📦 Other (22)"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdteoh%2Fdevdocs-macos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdteoh%2Fdevdocs-macos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdteoh%2Fdevdocs-macos/lists"}