diff --git a/docs/pages/icons/index.vue b/docs/pages/icons/index.vue index ab8d57ad7..71430463f 100644 --- a/docs/pages/icons/index.vue +++ b/docs/pages/icons/index.vue @@ -80,6 +80,19 @@

If the default Material icon library and/or community-contributed libraries are insufficient, use to create a new one.

+ +

+ For use in documentation such as the , all icons above have substitutions available in below: +

+ +

+ Copy and paste it into a file such as rstIconReplacements.txt and then add it to your conf.py file . +

+

+ Then in *.rst files you can use, for example, |video| to insert the video icon. Note that these icons will not have screen-reader-accessible labels associated with them, so they should always be accompanied by descriptive text. +

+
+ @@ -87,12 +100,18 @@ @@ -105,4 +124,14 @@ fill: blue !important; } + .replacements { + display: block; + width: 100%; + height: 100px; + font-size: smaller; + white-space: pre; + border: 1px solid #dedede; + border-radius: 4px; + } + diff --git a/nuxt.config.js b/nuxt.config.js index d4acf9962..39b07dfe0 100644 --- a/nuxt.config.js +++ b/nuxt.config.js @@ -47,6 +47,11 @@ export default { test: /\.tbx$/, loader: 'xml-loader', }); + // allow this file to be displayed + config.module.rules.push({ + test: /rstIconReplacements.txt/, + loader: 'raw-loader', + }); config.devtool = 'source-map'; }, cssSourceMap: true,