{"id":29636670,"url":"https://github.com/brpaz/ulauncher-docsearch","last_synced_at":"2025-07-21T17:34:10.635Z","repository":{"id":37039480,"uuid":"199916040","full_name":"brpaz/ulauncher-docsearch","owner":"brpaz","description":"Ulauncher extension for doing full text search on Documentation sites, powered by Algolia.","archived":false,"fork":false,"pushed_at":"2023-09-11T04:47:56.000Z","size":6836,"stargazers_count":24,"open_issues_count":6,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-07-30T16:51:22.467Z","etag":null,"topics":["algolia","documentation","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":"CHANGELOG.md","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","custom":"https://www.buymeacoffee.com/Z1Bu6asGV"}},"created_at":"2019-07-31T19:21:43.000Z","updated_at":"2024-06-21T00:08:16.000Z","dependencies_parsed_at":"2022-06-25T08:36:10.863Z","dependency_job_id":null,"html_url":"https://github.com/brpaz/ulauncher-docsearch","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/brpaz/ulauncher-docsearch","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brpaz%2Fulauncher-docsearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brpaz%2Fulauncher-docsearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brpaz%2Fulauncher-docsearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brpaz%2Fulauncher-docsearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brpaz","download_url":"https://codeload.github.com/brpaz/ulauncher-docsearch/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brpaz%2Fulauncher-docsearch/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":["algolia","documentation","ulauncher","ulauncher-extension"],"created_at":"2025-07-21T17:34:07.700Z","updated_at":"2025-07-21T17:34:10.611Z","avatar_url":"https://github.com/brpaz.png","language":"Python","funding_links":["https://github.com/sponsors/brpaz","https://www.buymeacoffee.com/Z1Bu6asGV"],"categories":[],"sub_categories":[],"readme":"# ulauncher-docsearch\n\n\u003e Search in your favorite Documentation sites directly from Ulauncher.\n\n[![Ulauncher Extension](https://img.shields.io/badge/Ulauncher-Extension-green.svg?style=for-the-badge)](https://ext.ulauncher.io/-/github-brpaz-ulauncher-docsearch)\n![License](https://img.shields.io/github/license/brpaz/ulauncher-docsearch.svg?style=for-the-badge)\n\n![Algolia](images/search-by-algolia-light-background.svg)\n\n## Motivation\n\nSearching documentation is a constant need but not an easy task. Switch contexts between your code editor to the browser, remember the documentation site url and then find what you need. Many times, I kwew exactly what I want to find and that I have seen before, but simple cant find it again.\n\nThis extension, aims to make documentation search less painfull, allowing you to a full text search on popular documentation sites directly from directly from ulauncher.\n\n## Features\n\nThis extension allows to easily search on popular documentation websites, that are built using [Algolia DocSearch](https://community.algolia.com/docsearch/) or [MkDocs](https://www.mkdocs.org/).\n\nThe following documentation sites are included by default in this extension:\n\n-   Apollo GraphQL\n-   Astro\n-   Babel\n-   Cypress\n-   Directus CMS\n-   Echo\n-   Eslint\n-   FluxCD\n-   Gatsby\n-   GitLab\n-   GORM\n-   Grafana\n-   GraphQL\n-   Gridsome\n-   Helm\n-   Jest\n-   Laravel\n-   Netlify\n-   NuxtJS\n-   Parcel\n-   Prettier\n-   Prisma\n-   Prometheus\n-   React\n-   Scala\n-   Strapi\n-   Supabase\n-   Symfony\n-   Tailwind\n-   Terraform\n-   Typescript\n-   Vercel\n-   Vite\n-   VitePress\n-   Vue\n-   Vuepress\n-   Vuetify\n-   Vuex\n-   Vue-Router\n-   Webpack\n-   Web.dev\n\nIt also includes the following using MkDocs:\n\n- Obsidian Dataview\n- Nginx ingress controller\n- ArgoCD\n\n## Requirements\n\n- Ulauncher V5\n- Python packages:\n  - ```pip install --user \"algoliasearch\u003e=2.0,\u003c3.0\"```\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-docsearch\n```\n\n\n## Usage\n\n![demo](demo.gif)\n\n\nOpen Ulauncher and type ```docs```. A list of available documentation sites will appear. Select one and type your search keyword to search on that website.\n\nOptionally some documentation also supports a custom keyword, to trigger it directly without having to type ```docs``` before.\n\nFor example, for Vue documentation, you can just type ```docs:vue \u003cquery\u003e```.\n\nYou can see the available keywords in [manifest.json](manifest.json) file.\n\n\n## Development\n\n```\ngit clone https://github.com/brpaz/ulauncher-docsearch\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\nAll contributions are welcome.\n\nIf you want to add new documentation, you can either do a PR so other users can benefit with it or adding it locally.\n\nPlease see the following guide to know how:\n\n* [Add new documentation](docs/add-new-doc.md)\n\n\n## 💛 Support the project\n\nIf this project was useful to you in some form, I would be glad to have your support.  It will help to keep the project alive and to have more time to work on Open Source.\n\nThe sinplest form of support is to give a ⭐️ to this repo.\n\nYou can also contribute with [GitHub Sponsors](https://github.com/sponsors/brpaz).\n\n[![GitHub Sponsors](https://img.shields.io/badge/GitHub%20Sponsors-Sponsor%20Me-red?style=for-the-badge)](https://github.com/sponsors/brpaz)\n\n\nOr if you prefer a one time donation to the project, you can simple:\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: auto !important;width: auto !important;\" \u003e\u003c/a\u003e\n\n## Author\n\n👤 **Bruno Paz**\n\n* Website: [brunopaz.dev](https://brunopaz.dev)\n* Github: [@brpaz](https://github.com/brpaz)\n* Twitter: [@brunopaz88](https://twitter.com/brunopaz88)\n## Credits\n\nThis project would never be possible without the awesome folks at [Algolia](https://www.algolia.com/) who build this search engine and all the websites that implemented it.\n\n## License\n\nCopywright [Bruno Paz](https://github.com/brpaz)\n\nThis project is [MIT](LLICENSE) Licensed.\n\n\u003ca href=\"https://www.flaticon.com/free-icons/guideline\" title=\"guideline icons\"\u003eGuideline icons created by Andrean Prabowo - Flaticon\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrpaz%2Fulauncher-docsearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrpaz%2Fulauncher-docsearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrpaz%2Fulauncher-docsearch/lists"}