Strip tags of ToC item's aria label

[pawamoy]

Some plugins/extensions might use the data-toc-label attribute of headings to set a particular string for the ToC item title.

While not explicitly documented as possible or allowed, they might set some HTML code instead of text. In this case, the aria label of Toc nav elements break the HTML as they will contain unescaped double quotes.

To fix this, we use the striptags filter to remove any tags from the aria label, keeping text only.

[squidfunk]

Thanks! Sounds legit, as previously discussed via Gitter. Some minor adjustments.

[squidfunk]

Please stick to our code style and insert spaces left and right to the | pipe ☺️ Also, please build the theme and make the changes in the material folder, or they won't be picked up.

[pawamoy]

I ran npm install then npm run build and committed a fixup.

[squidfunk]

Thanks! You need to run npm run build:all, or the custom overrides are not built.

[pawamoy]

Oh OK, this wasn't clear to me from the docs:

While this command will build all theme files, it will skip the overrides used in Material for MkDocs' own documentation which are not distributed with the theme. If you forked the theme and want to build the overrides as well, use:

I understood this as "use build:all if you have a custom fork of the theme" (I don't, I'm just sending a PR).
Maybe something simpler like "use build:all if you modified partials/overrides" would do the trick 🙂

[squidfunk]

Okay, sorry, last thing: the iconsearch index got deleted - please remove that from the commit as well. This is likely because the emoji database wasn't found in the virtual environment (we kind of assume that venv is the folder name):

mkdocs-material/tools/build/index.ts

Line 276 in 2cff287

const emojis$ = defer(() => resolve("venv/**/twemoji_db.py"))

This is a shortcoming of our current build process. We're going to revamp the docs and the process in the near future.

[pawamoy]

Sure, no worries! Indeed I usually use .venv as folder name 🙂

[squidfunk]

Perfect, good to go now!