Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • 09:25
    squidfunk commented #2245
  • 09:20
    squidfunk commented #2236
  • 09:18
    squidfunk commented #2152
  • 09:07

    github-actions[bot] on gh-pages

    Deployed 603fea6 with MkDocs ve… (compare)

  • 09:06

    squidfunk on master

    Updated Insiders documentation Merge branch 'master' of github… (compare)

  • 08:42
    funkypenguin opened #2245
  • 05:38

    github-actions[bot] on gh-pages

    Deployed b8fb5ee with MkDocs ve… (compare)

  • 05:37

    dependabot-preview[bot] on npm_and_yarn

    (compare)

  • 05:37

    dependabot-preview[bot] on master

    Bump preact from 10.5.10 to 10.… (compare)

  • 05:37
    dependabot-preview[bot] closed #2242
  • 05:36

    github-actions[bot] on gh-pages

    Deployed b0541b1 with MkDocs ve… (compare)

  • 05:35

    dependabot-preview[bot] on npm_and_yarn

    (compare)

  • 05:35

    dependabot-preview[bot] on master

    Bump @types/node from 14.14.21 … (compare)

  • 05:35
    dependabot-preview[bot] closed #2243
  • 05:35
    dependabot-preview[bot] synchronize #2242
  • 05:35

    dependabot-preview[bot] on npm_and_yarn

    Bump preact from 10.5.10 to 10.… (compare)

  • 05:35
    dependabot-preview[bot] edited #2242
  • 05:34

    github-actions[bot] on gh-pages

    Deployed 7454211 with MkDocs ve… (compare)

  • 05:33
    dependabot-preview[bot] edited #2242
  • 05:33

    dependabot-preview[bot] on npm_and_yarn

    (compare)

Oleh Prypin
@oprypin
so that is also what i used in my demo. this is the source for the nav: https://github.com/oprypin/crystal-book/blob/mkdocs/SUMMARY.md
as you said, it is indeed possible to check that this page is index.html specifically, and i used to have that clause, but it's inflexible / goes against the philosophy, because the file/directory structure must be decoupled from nav definition
Oleh Prypin
@oprypin
If there actually is a way to do it (mostly) natively with MkDocs without the support of a plugin
there really isn't and it had been rejected as you know. the best you can do is do some magic check against the first child of a section, and move it outside. that is too messy for a template to implement, and also too controversial to have on by default
a plugin really is the perfect way to implement opt-in
as per my implementation, now all that a template needs to do is consider the case that a nav item might have both children and url
Martin Donath
@squidfunk

that is too messy for a template to implement

have you looked at the Material for MkDocs templates? :D There are so many hacks

I need to think about this a little. Feel free to open an issue so we can discuss.
Oleh Prypin
@oprypin
yes let me write this down properly this evening
Martin Donath
@squidfunk
Cool, thanks for our work on this!
Martin Donath
@squidfunk
*your
Oleh Prypin
@oprypin
@squidfunk i finally finished a README, which at the bottom also clarifies my arguments so far.
https://github.com/oprypin/mkdocs-section-index#readme
Martin Donath
@squidfunk
Great write-up!
Stephen Gates
@Stephen-Gates
^^^ Thank you both for progressing this. Would love to use that feature on my sites.
Oleh Prypin
@oprypin
@Stephen-Gates you can do that now 🙃
Stephen Gates
@Stephen-Gates
Just did it. Works perfectly :-) Thanks for your work.
Martin Donath
@squidfunk
@sponsors – I just added all of you with access to the private repository to the new private Docker image on GitHub Container Registry. I don't know whether GitHub sent an email, but I'm currently updating the docs which should explain how to use it
Martin Donath
@squidfunk
:tada: Material for MkDocs Insiders 1.11.0 brings support for rendering Admonitions as inline blocks - no configuration required! Documentation: https://squidfunk.github.io/mkdocs-material/reference/admonitions/#inline-blocks
admonition-inline-end.png
Oleh Prypin
@oprypin
@squidfunk should I create a new issue? (or #1008) / how much noise can I make on pre-existing issues (in case those people are still interested)?
Martin Donath
@squidfunk
You can create a new issue where we can discuss the solution, however I‘m still not convinced this should be a plugin, but let‘s find out 😊
An issue is also a good idea to see how many users have this problem and if it's worth integrating
And yeah you can make some noise, so we get a discussion going.
Oleh Prypin
@oprypin
Martin Donath
@squidfunk
Great! Thanks!
Lars
@wilhelmer
WARNING - Template skipped: 'search.xml' not found in theme directories. - what's with that? Introduced with the latest Insiders version
1 reply
Everything works, just wondering about the warning
Martin Donath
@squidfunk
That was an attempt to get OpenSearch to work. I'm not sure about it, yet. search.xml needs to be listed under static_templates.
I'll check it out on Sunday, when I continue working on Insiders. The warning should definitely not be there.
Martin Donath
@squidfunk
Context for the search.xml change: I was trying to integrate OpenSearch, which is a standard that allows to search directly from the browser bar (i.e. try to type "github.com" and then TAB), you can search GitHub directly. I haven't managed yet to get it working on Chrome, but it works 'okayish' on Firefox:
Ohne Titel.gif
Martin Donath
@squidfunk
Super small survey regarding theme mods: squidfunk/mkdocs-material#2071
Lars
@wilhelmer
Thanks for the info, Martin
Another thing, related to MkDocs, not Material, but maybe you have some thoughts on this
I use, like many others, the mkdocs-minify-plugin for minification. However, 404.html never gets minified. This is because the on_post_page event isn't fired for 404.html, and the plugin uses that event for HTML minification
Any quick idea how to work around that
Lars
@wilhelmer
Maybe use on_post_build and minify 404.html directly (hard-coded). But that seems a little hacky
Martin Donath
@squidfunk
Interesting, never realized that this was the case. Sounds definitely like a MkDocs issue so maybe create an issue over at their repository?
Lars
@wilhelmer
Maybe it's intended because 404 is kind of a system built-in page? Don't know
But yeah, I could add that to the 118 open issues for MkDocs ;-)
Martin Donath
@squidfunk
Hmm, don't know. It's passed to MkDocs as static template, so maybe there should be a on_template hook?
Oleh Prypin
@oprypin
@wilhelmer @squidfunk
it's possible to get your own on_template by hooking during on_env
https://github.com/search?q=TemplateRewritingLoader&type=code
this approach is even compatible if multiple plugins did this
@wilhelmer u can open an issue on their repo, pass this information on and cc me - @oprypin
Oleh Prypin
@oprypin
yay i did a thing
sysintelligent
@sysintelligent
image.png
Hey just start using the material theme and it's awesome. A noob question: how to make chevron next to the menu in the collapsible section (see screenshot above)? Thanks.
Martin Donath
@squidfunk
@oprypin yeah! Super psyched to see Crystal adopting Material for MkDocs! Great work!
@sysintelligent you just have to nest your pages in mkdocs.yml: https://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation