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

08:06

squidfunk commented #4115
Aug 16 18:25

ryparker commented #2613
Aug 16 15:51

MartinKolbAtWork commented #4115
Aug 16 14:19

squidfunk labeled #4256
Aug 16 14:19

squidfunk closed #4256
Aug 16 14:19

squidfunk commented #4256
Aug 16 14:01

ironicbadger opened #4256
Aug 16 09:27

squidfunk commented #4255
Aug 16 09:27

squidfunk labeled #4255
Aug 16 09:26

squidfunk closed #4255
Aug 16 09:26

squidfunk commented #4255
Aug 16 09:16

wandri opened #4255
Aug 16 08:14

ldeluigi commented #4206
Aug 15 17:57

dr-br commented #4253
Aug 15 15:40

squidfunk commented #4253
Aug 15 15:36

squidfunk commented #4253
Aug 15 15:35

squidfunk labeled #4253
Aug 15 15:35

squidfunk closed #4253
Aug 15 15:35

squidfunk commented #4253
Aug 15 15:06

dr-br opened #4253

cbjoldham

@cbjoldham

Sorry yes, exactly that the ellipsis behaviour, will create an issue.

Timm Wimmers

@adminradio

Hi, is there a way to include JS files on a per page basis? Maybe in the meta section of a page? I'm on "insiders".

Martin Donath

@squidfunk

You can just add a <script src="..."></script> to your Markdown file

2 replies

usulpt

@usulpt

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 :)

Martin Donath

@squidfunk

Regarding multi-language setups I recommend reading #2346

2 replies

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.

bradleyharden

@bradleyharden:matrix.org

[m]

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.

Martin Donath

@squidfunk

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.

bradleyharden

@bradleyharden:matrix.org

[m]

@squidfunk, did all of my messages not come through? I linked to #3174 above

I'm on Matrix, not Gitter, so maybe that's an issue?

Martin Donath

@squidfunk

No, all good. I was just referring to the issue you linked to give additional context on what's the current state on that matter: lack of interest, i.e. not many users need it. Thus, it makes currently no sense for me to invest the time to make that happen.

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

Dave Hirschfeld

@dhirschfeld

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:)

GL513

@gl513:matrix.org

[m]

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?

Martin Donath

@squidfunk

Yes, you can just override the CSS classes that reference those colors with additional CSS (see customization guide), i.e. .md-header and .md-typeset a

5 replies

GL513

@gl513:matrix.org

[m]

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?

Martin Donath

@squidfunk

Of course, just look at the CSS 😊 The best idea is to use the browser inspector to find out which CSS classes apply styles to an element. Then use these classes to override specific properties.

2 replies

Most of the components are defined here: https://github.com/squidfunk/mkdocs-material/tree/master/src/assets/stylesheets/main/layout

oprypin

@oprypin:matrix.org

[m]

@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

Martin Donath

@squidfunk

Yeah, could possibly use mkdocstrings for that!

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.

GL513

@gl513:matrix.org

[m]

I think I may have found a bug.
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?

GL513

@gl513:matrix.org

[m]

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 :)

Martin Donath

@squidfunk

Thanks!

I recommend setting up configuration validation, which should catch most errors

GL513

@gl513:matrix.org

[m]

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?

Martin Donath

@squidfunk

What do you mean by "older style"?

3 replies

GL513

@gl513:matrix.org

[m]

Okay, thanks :)

alkisg

@alkis:matrix.org

[m]

Is it possible to omit the TOC (at the right side) for a specific page?

1 reply

GL513

@gl513:matrix.org

[m]

wait no, you said right side.

image.png

what about removing the classes for it?

No, I was right the first time.

alkisg

@alkis:matrix.org

[m]

Indeed the link you provided covers it. Thank you very much

mondle

@mondle:matrix.org

[m]

When making a table with a right aligned field, the alignment goes to the sort button instead of the field text

right aligned table bug.png

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

Oleg Polakow

@polakowo

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.

Martin Donath

@squidfunk

Interesting. However, I'm not seeing this problem:

Bildschirmfoto 2022-05-24 um 13.04.50.png

The style recalculations might come from the animation of the code annotations

Bildschirmfoto 2022-05-24 um 13.05.37.png

If you can narrow it down, I'm happy to look into it. We need a reproducible example that shows the issue clearly.

One thing you could try: try setting prefers-reduced-motion: reduce via the Chrome dev tools and see whether the issue persists. If it goes away, it's very likely related to animations.

Oleg Polakow

@polakowo

Hmm seems to be indeed coming from annotations. Here's the timeline on Safari for the same page (see above)

Chat via Matrix