typescript-eslint / typescript-eslint/ts-api-utils
🚀 Feature: Add a Cmd/Ctrl + K search shortcut to the site
Open
Nobody has claimed this yet.
area: documentation
status: accepting prs
type: feature
- Dominant language
- TypeScript
- Stars
- 122
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
Bug Report Checklist
- I have tried restarting my IDE and the issue persists.
- I have pulled the latest
mainbranch of the repository. - I have searched for related issues and found none that matched my issue.
Overview
Following up on https://github.com/JoshuaKGoldberg/ts-api-utils/pull/70#discussion_r1111117518:
Adding a Ctrl/Cmd+K shortcut for search the way Docusaurus and a lot of other sites / site generators have
Is there an existing Typedoc plugin for this? I'd much rather reuse an existing one than than make one anew.
Additional Info
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No source file or test is named in the issue. Start by locating the site's search implementation and checking whether an existing Typedoc plugin provides the shortcut. Done means Cmd/Ctrl+K opens search reliably on the site, with behavior verified for both platforms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100