@squidfunk Hi! I'm new to mkdocs & material. This is probably a very basic question, but I can't seem to extend the theme effectively. How do I add something to the
<body>? Here's what I'm trying to solve: I'm adding a new GA-4 tag and keeping the older UA tag for now. For reasons! I've added the GA-4 tag via <extrahead>, which was easy. But I can't figure out how to add the Google Tag Manager (noscript) into the <body>.
Just looking at the new
I've got
I assume this is not intended behaviour?
Improved Tooltips option in Insiders and I'm not sure of the behaviour on a TOC that scrolls - I think the tooltip is trying to render on the original position of the TOC. Unfortunately if that was off the screen the tooltips do not appear to render...I've got
toc.integrate and toc.follow enabled as well as content.tooltips if they are possibly interacting.I assume this is not intended behaviour?
The TOC items do not have
title attributes – please make sure that you're not adding them in overrides.
Ah wait, or do you mean the logic that adds tooltips on ellipsis?
Okay, yes, I checked and the tooltips that render on ellipsis do not respect the scroll offset. Please create an issue, so it doesn't get forgotten. I'll look into it asap.
4 replies
hi, Martin. thinking of migrating an existing markdown structure to mkdocs, wondering if I can have multiple versions with multiple languages. I saw a guide for the multiple languages, but can I integrated that with mike? also, is there any other way to approach versioning other than mike? I can always do manual, but wanted to try something leaner and cleaner :)
Regarding alternate version methods – you can just build your versions in different folders, similar to how the multi-language setup works. It always depends on the use case.
And yes, multi-language can be integrated with mike. There's also the mkdocs-monorepo or mkdocs-multirepo plugins if you want to version different languages together.
However, I haven't built such a setup myself, so maybe someone else can share some experiences.
I'm trying to use Material for MkDocs for my collection of notes on various topics. Some of them are mini blog posts that I share with others, and some function as a lab notebook. I've looked at and used a couple different static site generators for this purpose, and I'm trying out Material for MkDocs for the first time now.
In any event, I would like to label each Markdown document with a date. I was able to add a date field in the metadata section and get that date to display on the page using a modified version of the approach given in this blog post.
Is it possible to somehow use that date field to filter search results? Issue squidfunk/mkdocs-material#3174 hints at it, but it looks like there wasn't much response.
This is currently not supported. However, I already thought of allowing users to index arbitrary metadata in documents, which could be configured via an additional configuration option of the built-in search plugin. A previous discussion happened in #3174, which was discontinued because of a lack of interest.
I'm on Matrix, not Gitter, so maybe that's an issue?
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.