Repository navigation
MkDocs theme: search by title, or full text with Pagefind - #2
Merged
Merged
Conversation
- search: titles (the default) puts a search box above the sidebar. Each page carries a hidden list of every page and ## section, and TagAction's search-results list (kovirlabs/tagaction#1) filters it as you type: no index to build and no theme script. Hidden without JavaScript. - search: pagefind loads Pagefind's search box from pagefind/ and marks each article for indexing; run `npx pagefind --site site` after `mkdocs build`. - search: false leaves it out. The README no longer lists callouts as missing: TagBrush.css 1.2 styles `!!! note` once the admonition extension is on, and the example shows one. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses two of the gaps reported for the tds-openapi docs: no search, and
!!! notecallouts showing as plain text.Search
theme: search:titles(default)##sections by title as you type. Each page carries a hidden list of every page and section, and TagAction's new search-results list filters it. No index to build, no theme script. Hidden without JavaScript.pagefindpagefind/and marks each<article>withdata-pagefind-body. Runnpx pagefind --site siteaftermkdocs build.falseNeeds kovirlabs/tagaction#1 released (TagAction 0.3). With the published TagAction 0.2.0 the box appears but the results list never shows, so release TagAction first. The README says so.
Callouts
The README listed admonitions as not working. TagBrush.css 1.2.0, now on npm and served by the
tagbrush@1CDN link, styles them. They still needmarkdown_extensions: [admonition]inmkdocs.yml, or MkDocs leaves!!! noteas text; the README now says that, and the example shows one.Checks
uv).Not in this PR: loading TagBrush.css and TagAction from the site's own copies instead of the CDN, and publishing the theme to PyPI. Both are separate changes.
🤖 Generated with Claude Code