ソースを参照

Merge pull request #2628 from ShilpaG813/devdocs-usage-cheatsheet

docs: add DevDocs quick usage cheatsheet section
Simon Legner 3 日 前
コミット
36224d5529
1 ファイル変更18 行追加0 行削除
  1. 18 0
      README.md

+ 18 - 0
README.md

@@ -165,6 +165,24 @@ Contributions are welcome. Please read the [contributing guidelines](./.github/C
 * [Filter Reference](./docs/filter-reference.md)
 * [Maintainers’ Guide](./docs/maintainers.md)
 
+## DevDocs Quick Usage Cheatsheet
+
+Below are some helpful shortcuts and usage tips that are not immediately obvious to new users:
+
+- Press <kbd>/</kbd> or <kbd>Ctrl + K</kbd> to instantly focus the search bar.
+- Press <kbd>?</kbd> to open DevDocs’ built-in help overlay.
+- Press <kbd>↑</kbd> or <kbd>↓</kbd> to navigate search results without touching the mouse.
+- Press <kbd>Enter</kbd> to open the highlighted search result.
+- Press <kbd>Backspace</kbd> to go back to the previously viewed page.
+- Press <kbd>Shift + S</kbd> to toggle the sidebar visibility.
+- Press <kbd>A</kbd> to open the list of all installed documentation sets.
+- Press <kbd>Esc</kbd> to close popups, overlays, and search.
+- Use the **⚡ Offline Mode toggle** to download docs for offline use.
+- You can pin specific documentation sets to the sidebar for quicker access.
+
+These shortcuts make DevDocs faster to navigate and more efficient for daily use.
+
+
 ## Related Projects
 
 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.