Where communities thrive

Join over 1.5M+ people
Join over 100K+ communities
Free without limits
Create your own community

Explore more communities

squidfunk/mkdocs-material

A Material Design theme for MkDocs

People

Repo info

Activity

15:21

squidfunk commented #2155
15:15

github-actions[bot] on gh-pages

Deployed e72af03 with MkDocs ve… (compare)
15:14

squidfunk on master

Fixed stale link in Insiders do… (compare)
15:03

AltarBeastiful commented #2155
10:32

squidfunk labeled #2563
10:12

martinbira opened #2563
08:02

github-actions[bot] on gh-pages

Deployed d038fa9 with MkDocs ve… (compare)
08:01

squidfunk on master

Updated funding methods Merge branch 'master' of github… (compare)
Apr 13 16:51

EdouardThiel commented #2550
Apr 13 16:29

squidfunk closed #2559
Apr 13 16:29

squidfunk commented #2559
Apr 13 16:29

squidfunk closed #2560
Apr 13 16:28

squidfunk commented #2560
Apr 13 16:28

squidfunk closed #2550
Apr 13 16:28

squidfunk commented #2550
Apr 13 15:38

EdouardThiel opened #2560
Apr 13 15:36

EdouardThiel opened #2559
Apr 12 22:39

polarathene commented #2429
Apr 12 22:38

polarathene commented #2429
Apr 12 19:53

squidfunk labeled #2551

Daniel R

@danierutu

Woah, that's awesome! :heart:

Isaac Muse

@facelessuser

Wow. That’s intersting. I’ll have to check it out. Do you control it with special classes?

Martin Donath

@squidfunk

Yes, it's done with regular Admonition syntax and some additional classes

Just a POC right now but it works exceptionally well already.

Martin Donath

@squidfunk

Here's a video showing how it'll work with collapsible Admonitions: https://twitter.com/squidfunk/status/1328243288785235975

Benjamin Staneck

@Stanzilla

oh man, how close are we to the next insiders -> normal push?

Martin Donath

@squidfunk

1.10.0 was released this weekend: https://github.com/squidfunk/mkdocs-material-insiders/releases

Benjamin Staneck

@Stanzilla

I meant for the next feature push to the non sponsorware version

Martin Donath

@squidfunk

Or do you mean funding goal / milestone? In that case $330 are still missing. The milestone as such is feature-complete as of 1.10.0.

Benjamin Staneck

@Stanzilla

ah, kk

Martin Donath

@squidfunk

Currently at $670. i posted a graph on Twitter last week

Im really hoping some companies will chim in. The growth rate is good at the moment, but mainly $10 sponsors. Currently 40 in total.

Martin Donath

@squidfunk

Somebody made a Gource animation of Material for MkDocs! 7000 icons coming in @5:00 https://www.youtube.com/watch?v=ZAMGVj_pvk4&ab_channel=Gourcer

Isaac Muse

@facelessuser

That’s funny. I would have liked to see them animate all the dependencies as well. Node dependencies: 5 hours later…

Martin Donath

@squidfunk

Haha yeah, that would be awesome to see. Big ball of mud probably 😉

apopova

@AnastasiaTWW

hi guys! have you ever tried to solve the problem with cached css and js contents? I've deployed a new script but it works only after all saved browser files are deleted. can I force css and js files update on the mkdocs-material side? I want to try to solve the problem on my side without changing the deployment configuration

Martin Donath

@squidfunk

All Material for MkDocs assets have chunk hashes, so I guess your problem relates to custom/extra CSS?

If so, the probably easiest thing you can try is using query-string based cached busting: https://css-tricks.com/strategies-for-cache-busting-css/#query-strings – albeit it's not a best practice, it's easier to implement than chunk hashes, which demand a build process.

apopova

@AnastasiaTWW

@squidfunk thanks a lot! looks like this hack helped :)

Martin Donath

@squidfunk

Glad I could help!

Benjamin Staneck

@Stanzilla

found some more search oddities, inserted "MoveTo" into a few more documents, search finds it but the preview does not show it

Martin Donath

@squidfunk

The search preview currently shows the text from the beginning, highlighting any words it finds in the first few sentences. The match may be at a latter point in the document.

Better search summaries are already on the roadmap: https://squidfunk.github.io/mkdocs-material/insiders/#biquinho-vermelho – it's something I wanted to do before, but it's far from easy to solve this for all of the 40 languages. However, it will definitely be addressed in the next months.

Benjamin Staneck

@Stanzilla

hrm yeah

it gives the impression that it does not find the searched for term at all currently

Martin Donath

@squidfunk

Jep, I'll push it up on my priority list, definitely something to improve 😊In the meantime, the search highlighting feature of Insiders helps to highlight the occurrences in the results.

Try searching for "awesome" on the Insiders docs and just press ENTER, it'll highlight the result in the text: https://squidfunk.github.io/mkdocs-material-insiders/deprecations/?h=+awesome#bundled-plugins

Benjamin Staneck

@Stanzilla

yeah insiders search is way better

luzai

@luzai

Hi, may I ask whether we could encrypt the pages with a password while rendering latex code successfully?

Martin B

@martinbira

Try it out with the mkdocs-encryptcontent-plugin, https://github.com/CoinK0in/mkdocs-encryptcontent-plugin

luzai

@luzai

Thank you, but I cannot render the latex code when using this plugin.

Martin Donath

@squidfunk

You probably need some logic that triggers MathJax after the content has been decrypted

Isaac Muse

@facelessuser

MkDocs uses Markdown, not LaTeX. If you want to parse LaTeX in Markdown, you need some kind of extension that can parse LaTeX inside Markdown, or at least preserve the LaTeX from being treated as Markdown and use a JavaScript Library to parse it afterwards. The latter is how most known Markdown extensions handle LaTeX math. Material’s documentation covers this here: https://squidfunk.github.io/mkdocs-material/reference/mathjax/. And the extension it references gives even more details in its own documentation: https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/.

Isaac Muse

@facelessuser

I realize now that you may have been referring to it not working with encryption which may be a separate issue.

luzai

@luzai

Thank you very much! If not encrypted, the formula can be rendered. But it not works with encryption. I would submit an issue to mkdocs-encryptcontent-plugin and ask about the logic that triggers MathJax after decrypted.

Oleh Prypin

@oprypin

can someone explain to me in which situation this line of code kicks in?
https://github.com/squidfunk/mkdocs-material/blob/86a4c47c0a/material/partials/nav-item.html#L38

Oleh Prypin

@oprypin

aha it kicks in for the currently active item. but then why isn't nav_item.active or something used?

Oleh Prypin

@oprypin

i'm now determined to implement clickable links.
still no idea why it wasn't added.
mkdocs/mkdocs#1042
https://gitter.im/squidfunk/mkdocs-material?at=5f8770e93775d02b5a0e8178

Oleh Prypin

@oprypin

it'll have to be a plugin messing with html of templates. but if i find some generic and non intrusive way to communicate this just within the nav then maybe the themes will get on board with this

Oleh Prypin

@oprypin

yep, it works!
https://github.com/oprypin/mkdocs-section-index/blob/master/mkdocs_section_index/plugin.py
result: https://oprypin.github.io/crystal-book/syntax_and_semantics/literals.html

Martin Donath

@squidfunk

Glad you achieved what you were aiming for. However, wouldn’t template extension be a better fit? Why a plugin?

Oleh Prypin

@oprypin

@squidfunk i haven't heard of "template extension". if you're talking about theme custom_dir, that's a project specific override, i didn't find a way to make it reusable

even with that, i wasn't satisfied with how much of the pre-existing html i needed to duplicate. that'd go stale quick

but the main point is, this template modification is just the smaller half of this. the important part is it introduces a "protocol" into the nav that themes could agree to cooperate on, i.e. just apply this modification upstream; it's backwards-compatible

I'll follow up on this later and send requests to theme owners. if they don't want, i can just keep maintaining a hack for that theme

Martin Donath

@squidfunk

Did you check mobile navigation?

Oleh Prypin

@oprypin

not initially, but seems like it just works.

Martin Donath

@squidfunk

There was quite a disussion in some issue (haven't looked yet) some time ago regarding this topic. Personally, I don't think the plugin approach will be resilient enough, as the HTML is subject so changes (sometimes), and some people are even still stuck on Material 4. Thus, it's better to integrate it with the themes, as you already suggested. However, I think that this should be solved at the template level. However, I don't know whether MkDocs currently supports this. There's a rather old issue which might have gone stale: mkdocs/mkdocs#1042

Chat via Matrix