{"id":29636711,"url":"https://github.com/brpaz/ulauncher-devdocs","last_synced_at":"2025-07-21T17:34:19.294Z","repository":{"id":42488864,"uuid":"158925426","full_name":"brpaz/ulauncher-devdocs","owner":"brpaz","description":"Ulauncher extension to search documentation on DevDocs","archived":false,"fork":false,"pushed_at":"2022-04-03T10:50:15.000Z","size":6386,"stargazers_count":33,"open_issues_count":3,"forks_count":14,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-02T05:58:54.615Z","etag":null,"topics":["devdocs","ulauncher","ulauncher-extension"],"latest_commit_sha":null,"homepage":"","language":"Python","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/brpaz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"brpaz","patreon":"brpaz","custom":"https://www.buymeacoffee.com/Z1Bu6asGV"}},"created_at":"2018-11-24T10:29:41.000Z","updated_at":"2024-04-17T02:41:01.000Z","dependencies_parsed_at":"2022-08-30T17:50:45.800Z","dependency_job_id":null,"html_url":"https://github.com/brpaz/ulauncher-devdocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/brpaz/ulauncher-devdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brpaz%2Fulauncher-devdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brpaz%2Fulauncher-devdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brpaz%2Fulauncher-devdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brpaz%2Fulauncher-devdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brpaz","download_url":"https://codeload.github.com/brpaz/ulauncher-devdocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brpaz%2Fulauncher-devdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266342809,"owners_count":23914262,"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-07-21T11:47:31.412Z","response_time":64,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":["devdocs","ulauncher","ulauncher-extension"],"created_at":"2025-07-21T17:34:15.607Z","updated_at":"2025-07-21T17:34:19.264Z","avatar_url":"https://github.com/brpaz.png","language":"Python","funding_links":["https://github.com/sponsors/brpaz","https://patreon.com/brpaz","https://www.buymeacoffee.com/Z1Bu6asGV"],"categories":[],"sub_categories":[],"readme":"# ulauncher-devdocs\n\n[![Build Status](https://img.shields.io/travis/com/brpaz/ulauncher-devdocs.svg)](https://github.com/brpaz/ulauncher-devdocs)\n[![GitHub license](https://img.shields.io/github/license/brpaz/ulauncher-devdocs.svg)](https://github.com/brpaz/ulauncher-devdocs/blob/master/LICENSE)\n\n\u003e [Ulauncher](https://ulauncher.io) extension to search documentation on [DevDocs](https://devdocs.io/)\n\n## Demo\n\n![demo.gif](demo.gif)\n\n## Requirements\n\n- Ulauncher \u003e5\n- Python \u003e= 3\n\n## Install\n\nOpen ulauncher preferences window -\u003e extensions -\u003e add extension and paste the following url:\n\n```\nhttps://github.com/brpaz/ulauncher-devdocs\n```\n\n## Usage\n\n### Basic configuration\n\nThe first thing you need to do is to Open Extension preferences and configure the \"List of Documentation to Download\". The value of this input needs to be a valid JSON array\ncontaining the \"slug\" of the documentation pages you want to download. You can get the \"slug\" by opening the desired documentation page in your browser and look at the value in the url.\n\n**Note** This is only for first level documentation.\n\nAfter configuring your documentation preferences, the extension will start downloading the documentation in background. (it might take some time, depending on the number of documentations to download). You will receive a notification when the index process finish.\n\nYou can then start searching Documentation from ulauncher using \"docs\" keyword.\n\n### Specific keywords.\n\nInstead of using \"docs\" as keyword for everything, you can specify specific keywords for each programming language. You can configure them in `manifest.json` file.\n\nEx:\n\n```json\n {\n      \"id\": \"ruby\",\n      \"type\": \"keyword\",\n      \"name\": \"ruby\",\n      \"default_value\": \"ruby~2.5\"\n},\n```\n\n**Note** The keyword id and name can be whatever you want, but the default value should match a existing language slug.\n\n### Configure how to open DevDocs\n\n- The default configuration will open the documentation on the default browser. You can change it to open in [Hawkeye](https://github.com/brpaz/hawkeye) or with the custom DevDocs protocol. This will allow opening directly on [DevDocs-desktop](https://github.com/egoist/devdocs-desktop) after this [PR](https://github.com/egoist/devdocs-desktop/pull/79) is merged.\n\n## Development\n\n```\ngit clone https://github.com/brpaz/ulauncher-devdocs\nmake link\n```\n\nThe `make link` command will symlink the cloned repo into the appropriate location on the ulauncher extensions folder.\n\nTo see your changes, stop ulauncher and run it from the command line with: `ulauncher -v`.\n\n## Contributing\n\nContributions, issues and Features requests are welcome.\n\n## Show your support\n\n\u003ca href=\"https://www.buymeacoffee.com/Z1Bu6asGV\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;\" \u003e\u003c/a\u003e\n\n## License \n\nCopywright @ 2019 [Bruno Paz](https://github.com/brpaz)\n\nThis project is [MIT](LLICENSE) Licensed.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrpaz%2Fulauncher-devdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrpaz%2Fulauncher-devdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrpaz%2Fulauncher-devdocs/lists"}