squidfunk/mkdocs-material

A Material Design theme for MkDocs

Oleh Prypin

@oprypin

@Stephen-Gates you can do that now 🙃

Stephen Gates

@Stephen-Gates

Just did it. Works perfectly :-) Thanks for your work.

Martin Donath

@squidfunk

@sponsors – I just added all of you with access to the private repository to the new private Docker image on GitHub Container Registry. I don't know whether GitHub sent an email, but I'm currently updating the docs which should explain how to use it

Martin Donath

@squidfunk

:tada: Material for MkDocs Insiders 1.11.0 brings support for rendering Admonitions as inline blocks - no configuration required! Documentation: https://squidfunk.github.io/mkdocs-material/reference/admonitions/#inline-blocks

Oleh Prypin

@oprypin

@squidfunk should I create a new issue? (or #1008) / how much noise can I make on pre-existing issues (in case those people are still interested)?

Martin Donath

@squidfunk

You can create a new issue where we can discuss the solution, however I‘m still not convinced this should be a plugin, but let‘s find out 😊

An issue is also a good idea to see how many users have this problem and if it's worth integrating

And yeah you can make some noise, so we get a discussion going.

Oleh Prypin

@oprypin

✔ squidfunk/mkdocs-material#2060

Martin Donath

@squidfunk

Great! Thanks!

Lars

@wilhelmer

WARNING - Template skipped: 'search.xml' not found in theme directories. - what's with that? Introduced with the latest Insiders version

1 reply

Everything works, just wondering about the warning

Martin Donath

@squidfunk

That was an attempt to get OpenSearch to work. I'm not sure about it, yet. search.xml needs to be listed under static_templates.

I'll check it out on Sunday, when I continue working on Insiders. The warning should definitely not be there.

Martin Donath

@squidfunk

Context for the search.xml change: I was trying to integrate OpenSearch, which is a standard that allows to search directly from the browser bar (i.e. try to type "github.com" and then TAB), you can search GitHub directly. I haven't managed yet to get it working on Chrome, but it works 'okayish' on Firefox:

Martin Donath

@squidfunk

Super small survey regarding theme mods: squidfunk/mkdocs-material#2071

Lars

@wilhelmer

Thanks for the info, Martin

Another thing, related to MkDocs, not Material, but maybe you have some thoughts on this

I use, like many others, the mkdocs-minify-plugin for minification. However, 404.html never gets minified. This is because the on_post_page event isn't fired for 404.html, and the plugin uses that event for HTML minification

Any quick idea how to work around that

Lars

@wilhelmer

Maybe use on_post_build and minify 404.html directly (hard-coded). But that seems a little hacky

Martin Donath

@squidfunk

Interesting, never realized that this was the case. Sounds definitely like a MkDocs issue so maybe create an issue over at their repository?

Lars

@wilhelmer

Maybe it's intended because 404 is kind of a system built-in page? Don't know

But yeah, I could add that to the 118 open issues for MkDocs ;-)

Martin Donath

@squidfunk

Hmm, don't know. It's passed to MkDocs as static template, so maybe there should be a on_template hook?

Oleh Prypin

@oprypin

@wilhelmer @squidfunk
it's possible to get your own on_template by hooking during on_env
https://github.com/search?q=TemplateRewritingLoader&type=code

this approach is even compatible if multiple plugins did this

@wilhelmer u can open an issue on their repo, pass this information on and cc me - @oprypin

Oleh Prypin

@oprypin

yay i did a thing

https://twitter.com/CrystalLanguage/status/1333420683662069761

sysintelligent

@sysintelligent

Hey just start using the material theme and it's awesome. A noob question: how to make chevron next to the menu in the collapsible section (see screenshot above)? Thanks.

Martin Donath

@squidfunk

@oprypin yeah! Super psyched to see Crystal adopting Material for MkDocs! Great work!

@sysintelligent you just have to nest your pages in mkdocs.yml: https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation

Laurent Franceschetti

@fralau

Hello, @squidfunk I am a little puzzled about metadata. I followed the guidance on https://squidfunk.github.io/mkdocs-material/reference/meta-tags/

In overrides/main.html I tried to do this:

{% extends "base.html" %}


{% block extrahead %}
<meta property="og:type" content="website" />
<meta property="og:title" content="{{ page.title }}" />
<meta property="og:url" content="{{ page.canonical_url }}" />
<meta property="meta" content="{{ page.meta }}" />
{% endblock %}

The problem is that page.meta does not contain anything (empty dictionary). :question: So if I'm trying to put anything that is in the YAML header, I get an an error.

And yet I see that you were able, in your website, to perfectly document the og: meta properties.

How did you do that ?

(I have also activated the meta extension).

Martin Donath

@squidfunk

page.meta is a dictionary, you'd have to list all keys spearately

Laurent Franceschetti

@fralau

Certainly (that was for the sake of test)

Martin Donath

@squidfunk

See how the base.html template does it: https://github.com/squidfunk/mkdocs-material/blob/b72314d7da0e7c8bd2dda2f45c21d9cf55557706/src/base.html#L41-L46

It's weird that it doesn't contain anything though

Laurent Franceschetti

@fralau

That's what I found strange.

I see that you took precautions: {% if page and page.meta and page.meta.description %}

Martin Donath

@squidfunk

Yes, that's necessary because of static templates, as they don#t have a pageobject (404.html) and metadata might not be activated

Thus, you might need to guard your calls like that.

Where communities thrive

People

Repo info

Activity