i also made a separate extension that happens to make that natural if you write your nav in markdown https://github.com/oprypin/mkdocs-literate-nav/blob/438ef076ce8000257bccd1b4f2216abcdb8654de/tests/markdown_to_nav/test_section_with_link.yml#L9 - turns the above sample into the below nav
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
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
I need to think about this a little. Feel free to open an issue so we can discuss.
@squidfunk i finally finished a README, which at the bottom also clarifies my arguments so far.
https://github.com/oprypin/mkdocs-section-index#readme
https://github.com/oprypin/mkdocs-section-index#readme
: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
@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)?
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.
1 reply
Everything works, just wondering about the warning
I'll check it out on Sunday, when I continue working on Insiders. The warning should definitely not be there.
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:
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
But yeah, I could add that to the 118 open issues for MkDocs ;-)
@wilhelmer @squidfunk
it's possible to get your own
https://github.com/search?q=TemplateRewritingLoader&type=code
it's possible to get your own
on_template by hooking during on_envhttps://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
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.