Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix MkDocs Search #150

Open
1 task done
ZeroIntensity opened this issue Feb 5, 2024 · 1 comment
Open
1 task done

Fix MkDocs Search #150

ZeroIntensity opened this issue Feb 5, 2024 · 1 comment
Labels
bug Something went wrong docs Documentation change good first issue An issue that isn't necessarily easy to implement, but not required to be an expert in view.py

Comments

@ZeroIntensity
Copy link
Owner

Is there an existing issue for this?

  • I have searched the existing issues

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.
@ZeroIntensity ZeroIntensity added bug Something went wrong docs Documentation change good first issue An issue that isn't necessarily easy to implement, but not required to be an expert in view.py labels Feb 5, 2024
@pawamoy
Copy link

pawamoy commented Feb 5, 2024

Relevant PR: mkdocs/mkdocs#3560.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something went wrong docs Documentation change good first issue An issue that isn't necessarily easy to implement, but not required to be an expert in view.py
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pawamoy @ZeroIntensity