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 –
Both possible. You can change the icon size with CSS and remove the site name by customizing the template. See the customization guide.
Thanks for your reply! I was able to hide the site_name by overriding the header.html partial. I removed the header title and kept everything else the same.
But no luck with the icon size. I have two different logo images for light mode and dark mode, so I used the setup mentioned in this discussion. And in my extra.css I just add this block:
.md-typeset .md-header__button\ md-logo img {
height: 3rem;
}But the icon size does not change with the number, am I missing something here?
Is it possible to include, during build time, markdown from directories that is not in the
docs folder?
Here's the source of the component: https://github.com/squidfunk/mkdocs-material/blame/master/docs/insiders/index.md#L156
Here's the JavaScript logic for that component: https://github.com/squidfunk/mkdocs-material/blob/master/src/overrides/assets/javascripts/components/sponsorship/index.ts
... and here's how its mounted: https://github.com/squidfunk/mkdocs-material/blob/master/src/overrides/assets/javascripts/bundle.ts
Note that this is not based on React or some other SPA framework since we're doing progressive enhancement. The whole workflow is based on RxJS, which is a great fit for enhancing static sites.
Thus, write your component as plain JavaScript and then mount it with RxJS. You can easily hook into instant loading and Material for MkDocs features.