Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • Feb 04 20:01
    userbradley commented #4988
  • Feb 04 19:56
    squidfunk labeled #4988
  • Feb 04 19:56
    squidfunk labeled #4988
  • Feb 04 19:55
    squidfunk closed #4988
  • Feb 04 19:55
    squidfunk commented #4988
  • Feb 04 18:22
    userbradley edited #4988
  • Feb 04 18:20
    userbradley opened #4988
  • Feb 04 16:53
    determinedguy closed #4986
  • Feb 04 14:10
    squidfunk labeled #4982
  • Feb 04 14:10
    squidfunk unlabeled #4982
  • Feb 04 14:10
    squidfunk commented #4982
  • Feb 04 14:07
    squidfunk labeled #4983
  • Feb 04 14:07
    squidfunk unlabeled #4983
  • Feb 04 14:00

    github-actions[bot] on gh-pages

    Deployed a6565f3e1 with MkDocs … (compare)

  • Feb 04 13:59
    squidfunk labeled #4986
  • Feb 04 13:59
    squidfunk commented #4986
  • Feb 04 13:59

    squidfunk on master

    Updated Indonesian translations… (compare)

  • Feb 04 13:40
    axieum commented #4827
  • Feb 04 13:16
    jmcx commented #4985
  • Feb 04 13:16
    jmcx commented #4985
Martin Donath
@squidfunk
All sections of the documentation where you can set icons include the icon search behind the tooltip
Lukasz Kowalski
@nieprzecietny
hiya! dummy question , in documentation is written that we can override easily tasklist , i am wondering how to do that
i want to represent folder structure in project
not sure if this is good idea for that but i would like to ovveride icons with folder/file sign
Martin Donath
@squidfunk
Definitely possible and achievable with some CSS skills.
Martin Donath
@squidfunk
8.2+13+insiders-4.14.0 adds proper text segmentation support for Chinese as part of the built-in search plugin. The latest blog article explains how to set it up πŸš€
Martin Donath
@squidfunk
Insiders 4.15.0 adds support for tooltips – https://squidfunk.github.io/mkdocs-material/reference/tooltips/
pawamoy
@pawamoy:matrix.org
[m]
nice! hey, just saw your use of <div class="result" markdown> in your sources, is this from insiders too?
pawamoy
@pawamoy:matrix.org
[m]
ooooooh seems to work, though it misses a bit of padding-top on my end
pawamoy
@pawamoy:matrix.org
[m]
seems to be because the div actually eats space above πŸ€” to clarify: this is auto-generated using markdown-exec, so probably something faulty on my side
ah, it's because of margin-top: -1.125em;, but you have it as well so not sure what's happening
Martin Donath
@squidfunk
The .results class is unofficial, and meant to be directly preceded by a code block
I haven't yet decided whether I'd add it to the docs, because of that
= very limited use case
The negative margin is needed to undo the margin of the preceding code block
pawamoy
@pawamoy:matrix.org
[m]
ah, thanks, I think I found it thanks to you: in a tab, the margin-top/bottom are overridden with this: .md-typeset .tabbed-block > .highlight:first-child > pre, .md-typeset .tabbed-block > pre:first-child { margin: 0; }
and if it's unofficial I should probably not add support for it in markdown-exec anyway ^^
but it looks nice!
Martin Donath
@squidfunk
Yeah, I'm not using the .result in combination with tabs in the documentation, so that's definitely a side effect that we need to fix if we'd make it officially supported. Maybe in the future I find some time to do that, but until then you're on your own πŸ˜‰ The thing is: it's probably only useful for documentation that generates something visually like Material for MkDocs, where you want to show the result as part of the example.
Same as for the "view source of this page" button that I added to the docs
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.