mkdocs-material icon indicating copy to clipboard operation
mkdocs-material copied to clipboard

Rewrite tags documentation

Open squidfunk opened this issue 1 year ago • 2 comments

This branch includes a rewrite of the tags documentation, given the new capabilities of the tags plugin.

squidfunk avatar Dec 23 '23 18:12 squidfunk

You might want to fix this small typo while rewriting: https://github.com/squidfunk/mkdocs-material/blob/246266fafad2c2fdc78022c14f7f4b2df91167f3/docs/plugins/tags.md?plain=1#L558 As it should probably mean tags:

DanielHabenicht avatar Jan 03 '24 17:01 DanielHabenicht

Thanks, @DanielHabenicht! Fixed in 8023ffef8.

squidfunk avatar Jan 30 '24 03:01 squidfunk

Will this update provide a sort by tag-name capability as requested here? Is there an estimated availability date for this?

Xocotet avatar Mar 13 '24 13:03 Xocotet

This is already available in Insiders via listings_sort_by, e.g.:

plugins:
  - tags:
      listings_sort_by: !!python/name:material.plugins.tags.item_title

You can also provide a custom comparison function.

squidfunk avatar Mar 14 '24 00:03 squidfunk

I'm closing this PR, since we're not planning to move forward in this specific way. We're currently in the midst of a pretty big restructuring of our documentation, and it's just too early to consider for collaboration on new tags documentation.

@alexvoss you might consider using the diagrams in a tutorial, if they fit in the flow 😉

squidfunk avatar Apr 27 '24 01:04 squidfunk