You could patch the search plugin yourself, add the data to the search index, and then patch the indexing pipeline + rendering of search results in the frontend. We already do it with the
tags metadata to make tags searchable: https://github.com/squidfunk/mkdocs-material/blob/0c555b2c9f667cf453a1ebad58123204f4a9c85b/src/plugins/search/plugin.py#L48-L49
Some of them are mini blog posts
There's an issue for supporting blog posts (squidfunk/mkdocs-material#3353) which I'm keenly watching and has garnered some support (:+1:)
Hello. Is there any way to configure the header and the link color to be different colors instead of using "--md-primary-fg-color" to manage both, without having to go and extend the theme?
In case I need it, or for future reference, is there a list of all of the things I can use in the extra.css, such as
.md-header?
Most of the components are defined here: https://github.com/squidfunk/mkdocs-material/tree/master/src/assets/stylesheets/main/layout
@squidfunk: you could put specially marked comments intertwined with the CSS and then automatically extract those comments.
but anyway for me it would not be easier to browse a list of classes than just inspect in browser
However, I'd doubt that many users need it. Most should be fine with the CSS variables. There are not many users asking for "how could I solely style the header?"
Inspecting the browser is almost always a better idea, as classes sometimes need to be very complex, so it might not be apparent which styles to apply to users not used to CSS.
I think I may have found a bug.
I wanted to remove the generator notice, and put the notice elsewhere, so I appended
I wanted to remove the generator notice, and put the notice elsewhere, so I appended
generator: false under extra:, but it doesn't seem to be working. Should I make an issue on github?
Nevermind. I solved it. It was a misconfig. I did see your twitter post, Martin. I'll try to be the best I can with getting back to you if I do have an issue :)
I recommend setting up configuration validation, which should catch most errors
I cloned the repository and set it up as a local site hosted with mkdocs serve, but I noticed, it's in the older style. Does this mean the actual documentation is outdated too?
Is it possible to omit the TOC (at the right side) for a specific page?
1 reply
what about removing the classes for it?
No, I was right the first time.
When making a table with a right aligned field, the alignment goes to the sort button instead of the field text
It looks weird because that sort icon only appears on hovering
Sidenote, it would be nice to turn on and off sortable per table
4 replies
Hello, I'm getting high CPU usage of any page published with Mkdocs Material (Insiders). For example, if you go to your page https://squidfunk.github.io/mkdocs-material/publishing-your-site/ and this tab remains active, the CPU usage jumps to 40-50% and stays the same even without scrolling or any activity on the page. I tried analyzing the performance on both Safari and Chrome and the issue is coming from constant "recalculating style". Any ideas how to mitigate the issue? It becomes worse the longer the page is.
The style recalculations might come from the animation of the code annotations
If you can narrow it down, I'm happy to look into it. We need a reproducible example that shows the issue clearly.
One thing you could try: try setting
prefers-reduced-motion: reduce via the Chrome dev tools and see whether the issue persists. If it goes away, it's very likely related to animations.
Hmm seems to be indeed coming from annotations. Here's the timeline on Safari for the same page (see above)
License page (https://squidfunk.github.io/mkdocs-material/license/) doesn't have this problem, as there are no annotations apparently
Did find a couple examples (not material design) where the sort button is visible all the time which makes it look less strange
But your thinking of putting it on the left is probably better
This is actually a reasonable feature request
The google-search.mov demos how the selecting words works. The mkdocs-search.mov shows the selecting bug when search with "中文"(with result), and when search with "測試"(without result) everything is fine.
Maybe we can change the keyup event in search/query/index.ts with CompositionEvent to fix the selecting bug?