Skip to content

Commit 144f44d

Browse files
committed
Extend README for icon shortcode
1 parent 22d82c8 commit 144f44d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -436,12 +436,18 @@ the `icon` shortcode to inline an SVG file for a visual reference as
436436
demonstrated below:
437437

438438
```markdown
439-
First off, select all nodes ({{< icon "select-all" >}}), then right-click.
439+
Select all nodes ({{< icon "select-all" >}}), then right-click.
440440
```
441441

442442
Icons are supposed to supplement the text, i.e. not be embedded in sentences.
443443
They are hidden from screen readers.
444444

445+
To add new icons to the toolchain, save them to `site/content/images/icons/`.
446+
They are referenced by file name (without extension) in the shortcode.
447+
448+
SVG icon files should not define the attributes `width`, `height`, `aria-hidden`,
449+
and `focusable` on the `<svg>` tag.
450+
445451
#### Keyboard shortcuts
446452

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

0 commit comments

Comments
 (0)