Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • 13:44

    github-actions[bot] on gh-pages

    Deployed 7ca1c1d62 with MkDocs … (compare)

  • 13:43
    squidfunk closed #4451
  • 13:43
    squidfunk commented #4451
  • 13:43
    squidfunk labeled #4451
  • 13:43
    squidfunk labeled #4451
  • 13:42
    squidfunk commented #4451
  • 13:42
    squidfunk commented #4451
  • 13:42

    squidfunk on master

    Removed unnecessary non-null hi… (compare)

  • 13:39

    github-actions[bot] on gh-pages

    Deployed 6344549ec with MkDocs … (compare)

  • 13:38
    squidfunk commented #4451
  • 13:38

    squidfunk on master

    Improved resilience of reposito… (compare)

  • 13:23

    github-actions[bot] on gh-pages

    Deployed 914982b25 with MkDocs … (compare)

  • 13:23
    squidfunk labeled #4452
  • 13:23
    squidfunk labeled #4452
  • 13:23
    squidfunk closed #4452
  • 13:23
    squidfunk commented #4452
  • 13:22

    squidfunk on master

    Updated Insiders changelog (compare)

  • 11:55
    facelessuser commented #4452
  • 08:58
    squidfunk commented #4452
  • 04:13
    facelessuser commented #4452
Roger Lee Cormier
@xivor
I did set the GH_Token, but that was not the issue. I just realized that I had added an entry for material in requirements.txt, which is where it bombed. Thanks! It worked this time!
Martin Donath
@squidfunk
Great, glad you solved it
Ankit Malik
@DiabolusGX

You're getting a 403, so it's likely a problem with permissions.
Haven't seen this one yet, though.

Needed personal access token, even on public repo, not sure why is that but solved it with adding this in steps:

      - name: Deploy MkDocs
        uses: mhausenblas/mkdocs-deploy-gh-pages@1.24
        env:
            PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
Benjamin Staneck
@Stanzilla
Stripe open source markdoc today, looks pretty neat https://markdoc.io/
Martin Donath
@squidfunk
I'd be very interested in what you think of it
Martin Brochhaus
@mbrochh
Hi all, when I have some docs in a folder called something-test, MKDocs renders the collapsible headline in the sidebar for that folder as Something test. Is there a way to make it render it exactly as the folder name is on my disc?
Martin Brochhaus
@mbrochh
Uhhh... mkdocs-awesome-pages-plugin does the job!
Ankit Malik
@DiabolusGX
I came across this: https://github.com/squidfunk/mkdocs-material/discussions/3405
to remove some items from tabs but I want to add items on left side nav menu, I guess I'll have to override that but only on Home tab, can someone help me with identifier on which tab is active? I'm planning to show Site title and other titles that I'll hide from tabs, do I have to hardcoded them or is there any way to co-relate them?
Martin Donath
@squidfunk
I hope I correctly understand your request, but the way to do this is actually by using theme extension in order to create a new main.html template, which includes your changes (e.g. override the site_nav block), and then set this template only for the page.
If that doesn't answer your question, it's a good idea to provide some more information on what you exactly want to achieve and a concrete example as part of a discussion.
Zoran Pandovski
@ZoranPandovski_twitter
Hi everyone. We want to embed the search functionality from our documentation built using (mkdocs, mkdocs-material) into another frontend app? Does anyone else have experience with this?
Martin Donath
@squidfunk
None that I heard of. Should be possible though.
If you only want to link to search results, you can just use deep linking, like so: https://squidfunk.github.io/mkdocs-material/?q=open+search – if you want results and completions instantly in your app, you need a deeper integration.
Blueswen
@Blueswen
Hi @squidfunk , I saw Chinese search has been supported in in-sider version https://squidfunk.github.io/mkdocs-material/blog/2022/chinese-search-support/ . I wrote my own Chinese search mkdocs plugin with jieba too but with a lot of ugly workarounds. Is there any posable I could develop this feature together ?
Martin Donath
@squidfunk
@Blueswen sure, you're very much invited to contribute to Insiders, if you like! Happy to improve support.
Blueswen
@Blueswen
So I still have to become the sponsor then I can contribute right?
Martin Donath
@squidfunk
Jup. Insiders contains a complete rewrite of the search plugin, and the experimental Chinese support is part of that. It'll take some time until we reach the funding goal which contains Chinese support, which gives us the opportunity to flesh out bugs and improve it so it's stable when released into the community edition.
Benjamin Staneck
@Stanzilla

I'd be very interested in what you think of it

I think it's very promising, and it being in JS instead gives it a big chance of being adopted widely. But it needs that mkdocs-material equivalent and framework around it to be as easy to use. but I saw the Tailwind guys are currently on something like that, using next and tailwind

Martin Donath
@squidfunk
@Stanzilla You mean regarding Markdoc? Yet another documentation framework 😉
Only 10% of users of Material for MkDocs are frontend engineers, and most don't have much JavaScript knowledge. IMHO, Markdoc is a serious competitor for Docusaurus, but less for Material for MkDocs. However, I might be wrong, but this is my educated guess. I'll follow Markdoc closely.
Benjamin Staneck
@Stanzilla
yea
Martin Donath
@squidfunk
Nonetheless, I also believe that many will adopt it due to the quality of the developer documentation of Stripe, which is perceived as one of the best technical documentations out there.
Martin Donath
@squidfunk
Interestingly, it got to 3,5k stars in only 9 days. This took more than 4 years for Material for MkDocs. But Stripe is also a much, much bigger name than Martin Donath 😂
Kimberly Garmoe
@kagarmoe
@squidfunk Hi! I'm new to mkdocs & material. This is probably a very basic question, but I can't seem to extend the theme effectively. How do I add something to the <body>? Here's what I'm trying to solve: I'm adding a new GA-4 tag and keeping the older UA tag for now. For reasons! I've added the GA-4 tag via <extrahead>, which was easy. But I can't figure out how to add the Google Tag Manager (noscript) into the <body>.
Martin Donath
@squidfunk
There are several blocks in the body that you can use/extend, for example scripts at the bottom.
cbjoldham
@cbjoldham
Just looking at the new Improved Tooltips option in Insiders and I'm not sure of the behaviour on a TOC that scrolls - I think the tooltip is trying to render on the original position of the TOC. Unfortunately if that was off the screen the tooltips do not appear to render...
I've got toc.integrate and toc.follow enabled as well as content.tooltips if they are possibly interacting.
I assume this is not intended behaviour?
Martin Donath
@squidfunk
Tooltip on the toc? It doesn't sound like intended behavior, happy to look into it. Please create an issue with screenshots and a minimal reproducible example.
The TOC items do not have title attributes – please make sure that you're not adding them in overrides.
Ah wait, or do you mean the logic that adds tooltips on ellipsis?
Okay, yes, I checked and the tooltips that render on ellipsis do not respect the scroll offset. Please create an issue, so it doesn't get forgotten. I'll look into it asap.
4 replies
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