squidfunk/mkdocs-material

A Material Design theme for MkDocs

Martin Donath

@squidfunk

Yeah, it's the same with all of my repositories

Benjamin Staneck

@Stanzilla

missing permission or so?

Martin Donath

@squidfunk

I didn't change anything and it worked perfectly before.

Where could permissions be missing?

Benjamin Staneck

@Stanzilla

in the app settings, I would try reinstalling it on GitHub

Martin Donath

@squidfunk

Just released 5.2.0 btw

Only 4 open issues and one of them is the tutorials discussion. I think that's a historical low.

Benjamin Staneck

@Stanzilla

yay

Bilal

@bilal-fazlani

I am trying it with docker and getting

WARNING -  Config value: 'dev_addr'. Warning: The use of the IP address '0.0.0.0' suggests a production environment or the use of a proxy to connect to the MkDocs server. However, the MkDocs' server is intended for local development purposes only. Please use a third party production-ready server instead.

Martin Donath

@squidfunk

That's correct. See the discussion in mkdocs/mkdocs#2108

This was the only solution we could settle on. Waylan wanted to do it anyway.

Bilal

@bilal-fazlani

Removed strict mode for now on local machine. Dark mode is looking good!

Martin Donath

@squidfunk

Cool!

Bilal

@bilal-fazlani

So the solution as I understand is - run on ci with strict but on local - dont use strict?

Martin Donath

@squidfunk

I have no experience with strict mode, maybe someone else can answer this.

Vyacheslav

@Voronenko

Good day. Perhaps silly question - if I want to have one of the pages in a completely different design - I am about to add custom layout to the theme overrides dir. But is there any way to have access to the templating variables, in particular defined by macros plugin?

I was hoping, I would be able to use custom var set defined as per https://mkdocs-macros-plugin.readthedocs.io/en/latest/ in elements of the custom template too

any workaround?

Martin Donath

@squidfunk

You can just define another template as front matter, like here: https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/docs/data-privacy.md

Within this template, you can customize whatever you want, add further CSS, use plugins etc.

Vyacheslav

@Voronenko

let me rephrase than, for example above, if I want also to use custom jninja templating in overrides/main.html itself, is there place/procedure where I can specify some additional variables for that layout template

Saying I want to load some custom set of dynamic variables to be used in that layout, in particular from json files

and use it in jinja logic - for loops over data inside layout and so on

for inner data (i.e. markdown files under docs itself) I usually use macros plugin. But it definitely does not expose those vars on layout level

Martin Donath

@squidfunk

I don't think that's possible. It's more related to MkDocs/Jinja, maybe you can ask on their issue tracker or support channel.

Maybe there's another plugin that does allow that. You could also check the MkDocs plugins wiki.

Benjamin Staneck

@Stanzilla

@squidfunk https://csswizardry.com/2020/05/the-fastest-google-fonts/ pretty interesting

oasvi

@oasvi

@squidfunk I am an absolute noob at this and have a few questions

How do I change the font to one that is not on Google Fonts?
How do I make a landing page like yours

And how do I host properly on GitHub Pages because I am lost

Also, when I set the favicon, it resets it after doing mkdocs build to your default one

Martin Donath

@squidfunk

The docs will get a makeover and lay out the steps in a more user friendly way in the future. I just need some time to work on that, but unfortunately I don't have much time on my hands right now. Need to finish other projects and do some client work 😅 hope that more people sponsor this project in the future, so I can devote more time to it.

meanwhile, there's a feature beach where we started tutorials section: https://deploy-preview-1586--mkdocs-material-preview.netlify.app/tutorials/github-pages/ you should find some directions there.

*branch

Benjamin Staneck

@Stanzilla

@squidfunk https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fsquidfunk.github.io%2Fmkdocs-material%2F do you think it would be worth preloading the search worker?

Martin Donath

@squidfunk

I don't know. If it makes a difference on a mint Material for MkDocs installation, we can preload it. For this to be integrated, we need to measure actual load time with and without on mobile and desktop devices and see whether it makes a difference. If you want to go down that road, we can work on it in as part of a PR.

However, please understand that I think that it doesn't make sense to blindly follow Lighthouse reports. Therefore – actual data in the form of a reproducible case. Probably a repository would be best.

Furthermore, measuring the Material for MkDocs landing page might not be representative. It contains a rather large image and no further content, so it's much more media-heavy than average docs.

Benjamin Staneck

@Stanzilla

well https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fsquidfunk.github.io%2Fmkdocs-material%2Fextensions%2Fadmonition%2F

but otherwise agree

Benjamin Staneck

@Stanzilla

heh, does it check if it is used more than once?

(webpack)

Martin Donath

@squidfunk

Lighthouse gives you an estimate, not real data. And yes, it should replace all occurrences.

Benjamin Staneck

@Stanzilla

somehow it does not want to

Martin Donath

@squidfunk

g modifier missing then: https://github.com/squidfunk/mkdocs-material/blob/11ddca100b37ac12786fa77a94e260878fea3186/webpack.config.ts#L307

Benjamin Staneck

@Stanzilla

I did not change that line from your config

Benjamin Staneck

@Stanzilla

oh you meant I should add it, yeah I guess something like return content.replace(new RegExp(from, 'g'), to)

Martin Donath

@squidfunk

Jup, you can PR if you like

Haven't considered the case of multiple replacements up to now, but it should be no problem to integrate.

Where communities thrive

People

Repo info

Activity