{"id":20225609,"url":"https://github.com/purescript/purescript-docs-search","last_synced_at":"2026-03-05T22:04:22.234Z","repository":{"id":39918511,"uuid":"196699563","full_name":"purescript/purescript-docs-search","owner":"purescript","description":"Search frontend for the documentation generated by the PureScript compiler","archived":false,"fork":false,"pushed_at":"2024-08-16T18:37:45.000Z","size":472,"stargazers_count":23,"open_issues_count":11,"forks_count":8,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-10-28T18:37:17.517Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PureScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/purescript.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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}},"created_at":"2019-07-13T08:47:52.000Z","updated_at":"2024-12-21T20:38:04.000Z","dependencies_parsed_at":"2022-07-29T02:39:15.833Z","dependency_job_id":"b41cbaa9-7b08-487e-b012-5fd781f9ebc0","html_url":"https://github.com/purescript/purescript-docs-search","commit_stats":{"total_commits":109,"total_committers":4,"mean_commits":27.25,"dds":0.09174311926605505,"last_synced_commit":"83e10152f1aa9126a55b8b70aa441c0b6ff5ceb5"},"previous_names":["spacchetti/purescript-docs-search"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/purescript/purescript-docs-search","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purescript%2Fpurescript-docs-search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purescript%2Fpurescript-docs-search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purescript%2Fpurescript-docs-search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purescript%2Fpurescript-docs-search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/purescript","download_url":"https://codeload.github.com/purescript/purescript-docs-search/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/purescript%2Fpurescript-docs-search/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30151963,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T21:15:50.531Z","status":"ssl_error","status_checked_at":"2026-03-05T21:15:11.173Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2024-11-14T07:13:52.293Z","updated_at":"2026-03-05T22:04:22.217Z","avatar_url":"https://github.com/purescript.png","language":"PureScript","readme":"# purescript-docs-search\n\n[![Build status](https://github.com/purescript/purescript-docs-search/actions/workflows/build.yml/badge.svg)](https://github.com/purescript/purescript-docs-search/actions/workflows/build.yml)\n\n**This project has been merged into the [spago codebase](https://github.com/purescript/spago/tree/master/docs-search)!**\n\nAn app that adds search capabilities to generated documentation for PureScript code.\n\nIt supports nearly-all functionality of [Pursuit](https://github.com/purescript/pursuit), including querying by type.\n\n## Installing\n\nWhen using [spago](https://github.com/spacchetti/spago), you don't need to install this app manually: run `spago docs` or `spago search`.\n\nOtherwise, use NPM (`npm install purescript-docs-search`) or [npx](https://github.com/npm/npx): `npx purescript-docs-search`.\n\n## Usage\n\nThere are two usage scenarios:\n\n### Patching static documentation\n\nUse `purescript-docs-search build-index` command to patch HTML files located in `generated-docs/html`. You then will be able to search for declarations or types:\n\n![Preview](preview.png)\n\nThe user interface of the app is optimised for keyboard-only use.\n\n**S** hotkey can be used to focus on the search field, **Escape** can be used to leave it. Pressing **Escape** twice will close the search results listing.\n\n### Using the CLI\n\nRunning `purescript-docs-search` within a project directory will open an interactive command-line session.\n\nNote that unlike in Pursuit, most relevant results will appear last.\n\nA quick demo:\n\n[![asciicast](https://asciinema.org/a/Hexie5JoWjlAqLqv2IgafIdb9.svg)](https://asciinema.org/a/Hexie5JoWjlAqLqv2IgafIdb9)\n\nYou may notice that the CLI offers slightly better results than the web interface. This is a performance tradeoff.\n\n## Development\n\n```\nnpm install\nnpm run build # or build-dev to skip JS compression stage\n```\n\nUse `spago docs --no-search \u0026\u0026 ./dist/purescript-docs-search.cjs build-index` to generate the docs and patch them using the local version of the app.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpurescript%2Fpurescript-docs-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpurescript%2Fpurescript-docs-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpurescript%2Fpurescript-docs-search/lists"}