Tagging support

[fleed]

Is it possible to define tags (or labels, as they are defined in GitHub) for pages and/or sections?

The current search is already powerful, but I'd like to define Tags that would help me organising arguments in a very large documentation.

Tags should be supported in search, eventually with a Filter by Tag functionality.

[waylan]

This sounds like an excellent candidate for a Plugin (see #206) when that becomes available.

[d0ugal]

Yup, I agree. This would be a good idea for a Plugin when it is possible. This is outside the scope of MkDocs for now.

[memeplex]

Maybe the symlinking capabilities of the underlying filesystem coupled with the ability of mkdocs to generate a categories structure from the folder structure could be exploited to get tagging without too much hassle. Currently it's very simple to classify the same page under multiple categories just symlinking it from different folders; the uglier aspect of this workaround being the duplication of output files, since the site generator doesn't replicate the symlinks but "expands" the structure instead.

[happicamper]

Just want to know if there is a plan for this feature to be implement inside MkDocs or is it already there? Thanks!

[waylan]

No, there is no plan.

[happicamper]

@waylan Is there a way we can use tags or labels for the search?

[waylan]

No, not at this time. As stated, there are no plans to officially support this and I don't expect that to change in the future as we consider it out-of-scope. However, if a third party plugin adds support, then it may be possible at that time. Unfortunately, plugins will not be possible until version 1.0 is released. The good news is that earlier today I pushed the plugin API to the 1.0.dev branch. The bad news is that there is still a lot of work to do before 1.0 is ready for a release and I can not provide a timetable.

[happicamper]

@waylan Thank you very much. Will look forward to this feature in the future.

[squidfunk]

More than five years later, tags support landed in Material for MkDocs 😅

Features:

• Tags can be added via front matter
• Tags are rendered below the main headline
• Tags are browseable via a dedicated tags index (can be linked anywhere from nav)
• Tags can be searched and are rendered as part of the preview

Demo (Tweet)