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
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
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!
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
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 😅
@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.
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
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
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
Haven't seen this one yet, though.
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!)
Anyone know why this happens in GH Actions?
Please see this for Insiders installation: https://squidfunk.github.io/mkdocs-material/insiders/getting-started/#with-pip
Note that you cannot use env variables in
requirements.txt
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 }}
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
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?
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.
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.
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 ?
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.
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
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.