WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit 36224d5

Browse files
authored
Merge pull request #2628 from ShilpaG813/devdocs-usage-cheatsheet
docs: add DevDocs quick usage cheatsheet section
2 parents ee13ea5 + 00d76ac commit 36224d5

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,24 @@ Contributions are welcome. Please read the [contributing guidelines](./.github/C
165165
* [Filter Reference](./docs/filter-reference.md)
166166
* [Maintainers’ Guide](./docs/maintainers.md)
167167

168+
## DevDocs Quick Usage Cheatsheet
169+
170+
Below are some helpful shortcuts and usage tips that are not immediately obvious to new users:
171+
172+
- Press <kbd>/</kbd> or <kbd>Ctrl + K</kbd> to instantly focus the search bar.
173+
- Press <kbd>?</kbd> to open DevDocs’ built-in help overlay.
174+
- Press <kbd>↑</kbd> or <kbd>↓</kbd> to navigate search results without touching the mouse.
175+
- Press <kbd>Enter</kbd> to open the highlighted search result.
176+
- Press <kbd>Backspace</kbd> to go back to the previously viewed page.
177+
- Press <kbd>Shift + S</kbd> to toggle the sidebar visibility.
178+
- Press <kbd>A</kbd> to open the list of all installed documentation sets.
179+
- Press <kbd>Esc</kbd> to close popups, overlays, and search.
180+
- Use the **⚡ Offline Mode toggle** to download docs for offline use.
181+
- You can pin specific documentation sets to the sidebar for quicker access.
182+
183+
These shortcuts make DevDocs faster to navigate and more efficient for daily use.
184+
185+
168186
## Related Projects
169187

170188
Made something cool? Feel free to open a PR to add a new row to this table! You might want to discover new projects via https://github.com/topics/devdocs.

0 commit comments

Comments
 (0)