Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • Nov 28 18:02
    squidfunk labeled #4686
  • Nov 28 17:52
    facelessuser commented #4686
  • Nov 28 15:43

    github-actions[bot] on gh-pages

    Deployed 39124f991 with MkDocs … (compare)

  • Nov 28 14:53
    joskfg opened #4686
  • Nov 28 12:38
    wilhelmer commented #4683
  • Nov 28 12:37

    github-actions[bot] on gh-pages

    Deployed 39124f991 with MkDocs … (compare)

  • Nov 28 12:36
    squidfunk labeled #4683
  • Nov 28 12:36
    squidfunk commented #4683
  • Nov 28 12:36
    squidfunk closed #4683
  • Nov 28 12:36

    squidfunk on master

    Documentation (compare)

  • Nov 28 12:35

    github-actions[bot] on gh-pages

    Deployed 8748c71df with MkDocs … (compare)

  • Nov 28 12:34

    squidfunk on master

    Updated Insiders changelog (compare)

  • Nov 28 12:25
    squidfunk commented #4683
  • Nov 28 11:58

    github-actions[bot] on gh-pages

    Deployed 8914c8dec with MkDocs … (compare)

  • Nov 28 11:57

    dependabot[bot] on npm_and_yarn

    (compare)

  • Nov 28 11:57
    dependabot[bot] closed #4681
  • Nov 28 11:57
    dependabot[bot] edited #4681
  • Nov 28 11:57
    dependabot[bot] commented #4681
  • Nov 28 11:57
    dependabot[bot] edited #4681
  • Nov 28 11:56

    squidfunk on master

    Updated dependencies (compare)

Martin Donath
@squidfunk
Okay, I think this needs to be fixed – we actually use it in the docs: https://squidfunk.github.io/mkdocs-material/reference/images/#image-alignment – I'll look into it 😅
Martin Donath
@squidfunk
@pawamoy:matrix.org I'm pretty confident that your issue should be fixed by squidfunk/mkdocs-material@7738685 – unfortunately, these CSS selectors need to be overly specific, so code blocks inside code annotations are not affected, which themselves can be hosted inside code blocks inside content tabs. Pretty insane.
pawamoy
@pawamoy:matrix.org
[m]
I've hardcoded a style tag into the div, to set margin-top to 0, with a TODO to remove it if/when it's fixed
yeah nesting capabilities are pretty insane haha
combined with the meta/literate-programming of my extension, it's... quite mind-blowing haha
Ankit Malik
@DiabolusGX
image.png
Hi, I'm new to Gitter so not sure how it works but I need some help with github action to auto build & deploy docs to site and I'm getting this error ^^^ on - run: mkdocs gh-deploy --force
Ankit Malik
@DiabolusGX
here is ci.yml file btw:
name: CI
on:
  push:
    branches:
      - master

  workflow_dispatch:

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v2
        with:
          python-version: 3.x
      - run: pip install --upgrade pip && pip install mkdocs mkdocs-gen-files
      - run: pip install mkdocs-material
      - name: Publish docs
        run: mkdocs gh-deploy --force
Martin Donath
@squidfunk
You're getting a 403, so it's likely a problem with permissions.
Haven't seen this one yet, though.
Roger Lee Cormier
@xivor
Are there any issues in using Jquery applications within the Mkdocs-Material ecosystem? The application I wish to use I cannot find a suitable vanillaJS alternative, and the Jquery application has become near industry standard.
Martin Donath
@squidfunk
None that I'd expect, using jQuery should be fine, although it will add a payload to your site that is almost as large (or larger?) than Material for MkDocs itself.
Roger Lee Cormier
@xivor
Thanks for the quick response. I understand, but unfortunately the datatables I want for a few pages, I cannot find a replacement for datatables.net that gives the filter and sort feature that I need while importing from json sources. There is a vanillaJS datatables on Github that is fairly refined but it just falls short of my needs (though definitely worth looking into for a plugin for Material for MKDocs if you are interested!)
Roger Lee Cormier
@xivor
image.png
Anyone know why this happens in GH Actions?
Martin Donath
@squidfunk
Probably because you didn't set theGH_TOKEN
Note that you cannot use env variables in requirements.txt
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.