Search finds a setting, a page, a project, or an action by name, so you don't need to know which menu holds it.
Use either of these from any page in the Redocly platform:
- Select Search at the top of the sidebar.
- Press
⌘ Cmd+Kon macOS, orCtrl+Kon Windows and Linux.
While the cursor is in the code editor, the shortcut keeps its editor action. Select Search in the sidebar to search from the editor.
Before you type, search lists recently opened pages and suggested actions.
- Open search.
- Type the start of a word, for example
accfor Access and Account, ordomainfor Custom domain. - Use the arrow keys to select a result, and press
Enterto open it.
Each word you type matches the start of a word in a result's name, the place it lives, or in other names people use for it. For example, token finds API keys.
If no result matches your query, the page says so. Try a different query.
To close search, press Esc.
Search groups the results by where they live:
| Group | What it finds | Example |
|---|---|---|
| Projects | The projects of the organization | Type part of a project name to open that project |
| Project pages | Pages of a project, such as Editor, Pull requests, and Deployments | deploy opens Deployments |
| Project settings | Settings of a project | branch opens Branches & Deployments |
| Organization settings | Organization settings, such as General, Billing, People, Teams, SSO and login, and API keys | teams opens Teams, where you give a team access to a project |
| Your account | Your account settings: Account, Notifications, Appearance, Connections, and Invitations | notif opens your notification settings |
| Organizations | Your other organizations | Type part of an organization name to switch to it |
| Actions | Common tasks, such as Create project, Invite members, Add custom domain, Add API key, and Switch to dark theme | invite opens the form to invite people to the organization |
Results depend on where you are. On a project page, search includes that project's pages and settings. On an organization page, search includes the pages and settings of every project you can open, with the project name next to each result. Add a word of the project name to narrow the results, for example cafe deploy for the Deployments page of the Cafe project.
Search displays only the pages and actions your role and plan let you use.
| Action | macOS | Windows and Linux |
|---|---|---|
| Open search | ⌘ Cmd + K | Ctrl + K |
| Move between results | ↑ or ↓ | ↑ or ↓ |
| Open the selected result | Enter | Enter |
| Close search | Esc | Esc |
- Keyboard shortcuts - Every shortcut you can use in the Redocly platform's editor
- Teams - Give people access to projects through teams
- Manage organizations - Change the settings that apply to every project in your organization