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

[Feat] docs: Add mkdocs tag to tool headers #5091

Open
cwhite911 opened this issue Feb 12, 2025 · 3 comments
Open

[Feat] docs: Add mkdocs tag to tool headers #5091

cwhite911 opened this issue Feb 12, 2025 · 3 comments
Labels
enhancement New feature or request

Comments

@cwhite911
Copy link
Contributor

Currently we are setting keywords in each tools md header, however we can take advantage of material for mkdocs' built in tags plugin for page categorization.

# mkdocs.yml
plugins:
  - tags

Current header of r.profile

---
name: d.profile
description: Plots profile of a transect.
keywords: display, profile, raster, plot
---

Header with tags support:

---
name: d.profile
description: Plots profile of a transect.
tags: display, profile, raster, plot
---
@petrasovaa
Copy link
Contributor

Could you explain what is the advantage specifically? I couldn't quite understand what the plugin does.

@cwhite911
Copy link
Contributor Author

It's the material mkdocs way of doing what we are doing with keywords. Some advantages are nice icon integration and an automated tags index. We don't need to do this right away, but I think it looks nice.

@cwhite911 cwhite911 changed the title [Feat] Add mkdocs tag to tool headers [Feat] docs: Add mkdocs tag to tool headers Feb 13, 2025
@wenzeslaus
Copy link
Member

I like the plugin and we already have rich keywords. I would knock down other things first though since we have system for keywords already in place and it has its own sophistication. It will be nice to drop that custom code at some point though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

No branches or pull requests

3 participants