Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for tags plugin? #237

Closed
chlab opened this issue Nov 26, 2024 · 2 comments
Closed

Support for tags plugin? #237

chlab opened this issue Nov 26, 2024 · 2 comments

Comments

@chlab
Copy link

chlab commented Nov 26, 2024

Hi team

First of all, thanks for all your great work on techdocs!

I just wanted to try the built-in tags plugin of Material for Mkdocs but it didn't work. After digging a bit deeper, I see that it doesn't seem to be activated in mkdocs-techdocs-core.

Are there any plans to enable this for techdocs? For us it would be great to create an overview page showing certain articles grouped by topic, similar to the example from Material:
tags-index

Cheers

@DSmedley
Copy link
Contributor

You should be able to use tags by simply adding it to your plugins list. Its included by default by mkdocs-material.

I also had issues getting it to work because it said the plugin was not installed. Im guessing it has something to do with how the material theme is being applied through techdocs-core but if you use the full qualifier it seems to work.

plugins:
  - techdocs-core
  - material/tags:
      tags_file: tags.md

@chlab
Copy link
Author

chlab commented Jan 22, 2025

@DSmedley I could have sworn that I tried every way under the sun to register the plugin and none of them worked but.. you're right! Maybe I had a whitespace issue or something. Anyway, the way you describe it works for me as well. Thanks!

@chlab chlab closed this as completed Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants