Skip to content

Commit 22d82c8

Browse files
committed
Rename icon files and mention icon shortcode to README
1 parent 62860ef commit 22d82c8

File tree

10 files changed

+16
-3
lines changed

10 files changed

+16
-3
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,19 @@ Available attributes:
429429
- `class`: CSS classes to apply
430430
- `style`: CSS inline styles to apply
431431

432+
#### Icons
433+
434+
If a web interface uses icons, especially as buttons without labels, use
435+
the `icon` shortcode to inline an SVG file for a visual reference as
436+
demonstrated below:
437+
438+
```markdown
439+
First off, select all nodes ({{< icon "select-all" >}}), then right-click.
440+
```
441+
442+
Icons are supposed to supplement the text, i.e. not be embedded in sentences.
443+
They are hidden from screen readers.
444+
432445
#### Keyboard shortcuts
433446

434447
To document hotkeys and key combinations to press in a terminal or graphical

site/content/3.12/graphs/graph-visualizer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ You can save queries for future use:
143143
6. Select a query from the list. The following actions are available for each query:
144144
- Copy ({{< icon "duplicate" >}}) the query string to the clipboard.
145145
- **Bind Variables** to set for the query.
146-
- Edit ({{< icon "edit_square" >}}) the query.
146+
- Edit ({{< icon "edit-square" >}}) the query.
147147
- Delete ({{< icon "delete" >}}) a no longer needed query.
148148
- Run ({{< icon "run" >}}) the query.
149149
{{< /tip >}}
@@ -220,8 +220,8 @@ displayed.
220220
- **Fit to Screen**: Resize and center the canvas so you can see everything
221221
({{< icon "fit" >}}).
222222

223-
- **Zoom Controls**: Zoom in ({{< icon "zoom_in" >}}), zoom out
224-
({{< icon "zoom_out" >}}), or reset the zoom to 100%.
223+
- **Zoom Controls**: Zoom in ({{< icon "zoom-in" >}}), zoom out
224+
({{< icon "zoom-out" >}}), or reset the zoom to 100%.
225225

226226
- **Download screenshot**: Save a PNG image of what is currently displayed on
227227
the canvas ({{< icon "download" >}}).
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)