Site usage-guide
An operational guide to reading docwright
Navigation
There are several methods for navigating through the pages of the knowledge base. The menu button (three horizontal bars) at the top-left of the page to open and close the sidebar. The sidebar lists all the sections and topics of the knowledge base. Click any topic to load that page. The menu bar, on the top, holds all the icons.
The keyboard shortcut b opens and closes the sidebar. The < left and right > arrow keys moves you to the previous and next page; the big arrow buttons at the sides of the page do the same thing. The ∧ up and down v arrow keys scroll up and down a page. The PgUp and PgDn jump high-level headings; Spacebar and Shift + Spacebar keys do the same thing. Clicking any where on the menu bar, other than the icons, will take you to the top of the page.
Note
If the window is too narrow, particularly on mobile displays, sidebar will not automatically appear. In that case, use the menu button to open and close the sidebar.
Menu Bar icons
| Icon | Description |
|---|---|
| Opens and closes the sidebar. You can also use b. | |
| Opens the search bar. You can also use / or S. | |
| Print the entire knowledge base. Press Ctrl + p to print only the current page. | |
| Opens a link to the provider hosting the source code of the knowledge base. | |
| Opens the page to directly edit the source of the page you are currently reading. | |
| Copies the code in the code block to your local clipboard, so you can paste it into another application. |
Theme
There are only two themes available, light or dark. This site’s theme aligns with and changes automatically when you change your system’s theme.
Search
To search for a topic on the site, open the search bar, and enter keywords to see matching topics and headings in real time. In the search list, the ∧ and v arrow keys help you select a result, and Enter opens that section. Esc closes the search bar.