ZeroIntensity / view.py

The Batteries-Detachable Web Framework
https://view.zintensity.dev
MIT License
205 stars 15 forks source link

Fix MkDocs Search #150

Closed ZeroIntensity closed 4 months ago

ZeroIntensity commented 8 months ago

Is there an existing issue for this?

Current Behavior

If you use the "Search documentation" feature on the docs, some of the results will appear as HTML elements (i.e. their title is <code>...).

Expected Behavior

It should instead display just a title (or not display it all).

Steps To Reproduce

Search "hello" on the docs, for example.

Anything else

This is likely due to mkdocstrings messing with TOC and the search displaying it with the extra mkdocstrings tag. If anyone is more experienced with MkDocs themes or mkdocstrings, feel free to work on this.

pawamoy commented 8 months ago

Relevant PR: https://github.com/mkdocs/mkdocs/pull/3560.

ZeroIntensity commented 4 months ago

This is no longer relevant as of the switch to mkdocs-material