// TODO: This file was created by bulk-decaffeinate. // Sanity-check the conversion and remove this comment. /* * decaffeinate suggestions: * DS102: Remove unnecessary code created because of implicit returns * DS205: Consider reworking code to avoid use of IIFEs * Full docs: https://github.com/decaffeinate/decaffeinate/blob/main/docs/suggestions.md */ app.templates.helpPage = function () { let key, value; const ctrlKey = $.isMac() ? "cmd" : "ctrl"; const navKey = $.isMac() ? "cmd" : "alt"; const arrowScroll = app.settings.get("arrowScroll"); const aliases_one = {}; const aliases_two = {}; const keys = Object.keys(app.models.Entry.ALIASES); const middle = Math.ceil(keys.length / 2) - 1; for (let i = 0; i < keys.length; i++) { key = keys[i]; (i > middle ? aliases_two : aliases_one)[key] = app.models.Entry.ALIASES[key]; } return `\

User Guide

Managing Documentations

Documentations can be enabled and disabled in the Preferences. Alternatively, you can enable a documentation by searching for it in the main search and clicking the "Enable" link in the results. For faster and better search, only enable the documentations you plan on actively using.

Once a documentation is enabled, it becomes part of the search and its content can be downloaded for offline access — and faster page loads when online — in the Offline area.

Search

The search is case-insensitive and ignores whitespace. It supports fuzzy matching (e.g. bgcp matches background-clip) as well as aliases (full list below).

The search can be scoped to a single documentation by typing its name (or an abbreviation) and pressing tab (space on mobile). For example, to search the JavaScript documentation, enter javascript or js, then tab.
To clear the current scope, empty the search field and hit backspace or esc.
The search can be prefilled from the URL by visiting devdocs.io/#q=keyword. Characters after #q= will be used as search query.
To search a single documentation, add its name (or an abbreviation) and a space before the keyword: devdocs.io/#q=js date.
DevDocs supports OpenSearch. It can easily be installed as a search engine on most web browsers:

Note: the above search features only work for documentations that are enabled.

Keyboard Shortcuts

Sidebar

${arrowScroll ? 'shift + ' : ""} ↓ ↑
Move selection
${arrowScroll ? 'shift + ' : ""} → ←
Show/hide sub-list
enter
Open selection
${ctrlKey} + enter
Open selection in a new tab
alt + r
Reveal current page in sidebar

Browsing

${navKey} + ← ${navKey} + →
Go back/forward
${ arrowScroll ? '↓ ' + '↑' : 'alt + ↓ ' + 'alt + ↑' + "
" + 'shift + ↓ ' + 'shift + ↑' }
Scroll step by step

space shift + space
Scroll screen by screen
${ctrlKey} + ↑ ${ctrlKey} + ↓
Scroll to the top/bottom
alt + f
Focus first link in the content area
(press tab to focus the other links)

App

ctrl + ,
Open preferences
esc
Clear search field / reset UI
?
Show this page

Miscellaneous

alt + c
Copy URL of original page
alt + o
Open original page
alt + g
Search on Google
alt + s
Search on Stack Overflow
alt + d
Search on DuckDuckGo

Tip: If the cursor is no longer in the search field, press / or continue to type and it will refocus the search field and start showing new results.

Search Aliases

Word Alias ${(() => { const result = []; for (key in aliases_one) { value = aliases_one[key]; result.push( `
${key}${value}`, ); } return result; })().join("")}
Word Alias ${(() => { const result1 = []; for (key in aliases_two) { value = aliases_two[key]; result1.push( `
${key}${value}`, ); } return result1; })().join("")}

Feel free to suggest new aliases on GitHub.\ `; };