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?
I've actually never heared about
CompositionEvent – let's discuss in an issue 😊
Hello, I have another question.
I wanted to add Giscus in a github repo, and enable it only on certain pages, but the guide doesn't make it entirely clear how one is supposed to do that. Can I get some pointers?
I can enable it universally, no problem, but there seems to be a disconnect.
I have a file in my overrides called "giscuschat.html", but when I put this in my .md files, it says this
I wanted to add Giscus in a github repo, and enable it only on certain pages, but the guide doesn't make it entirely clear how one is supposed to do that. Can I get some pointers?
I can enable it universally, no problem, but there seems to be a disconnect.
I have a file in my overrides called "giscuschat.html", but when I put this in my .md files, it says this
jinja2.exceptions.TemplateNotFound: giscuschat.html
The documentation explains this as part of the "adding a comment system guide":
You can either integrate Giscus on every page by overriding the main.html template, or create a new template (e.g. blog.html) to extend from main.html which includes the comment system, so you can decide for each page whether you want to allow comments or not.
Thus, create a new template, extend from
main.html, and just follow the steps in the guide.
4 replies
You can then opt-in a page into Giscus by setting the page template
I did make a github issue for admonitions, you may have seen a bit of activity because I was trying to get the code block to work, but it doesn't want to no matter what 😅
If you stick to the documentation, you should be fine.
No worries. If you find something that doesn't work as intended the next time you might first create a discussion or ask here, as you don't need to go through the formal process of creating an issue, saving both, you and me, time.
Hello! The "Navigation Pruning" link in the insiders article leads to a 404
https://squidfunk.github.io/mkdocs-material/insiders/#:~:text=available%20to%20sponsors%3A-,Navigation%20pruning,-Tooltips
https://squidfunk.github.io/mkdocs-material/insiders/#:~:text=available%20to%20sponsors%3A-,Navigation%20pruning,-Tooltips
1 reply
Oh, but going to the link results in a 404.
https://squidfunk.github.io/mkdocs-material/setup/setting.up-navigation.md#navigation-pruning
https://squidfunk.github.io/mkdocs-material/setup/setting.up-navigation.md#navigation-pruning
3 replies
– or –