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

[tags plugin] Add tags icons on tags index #4100

Closed
4 tasks done
Guts opened this issue Jul 7, 2022 · 4 comments
Closed
4 tasks done

[tags plugin] Add tags icons on tags index #4100

Guts opened this issue Jul 7, 2022 · 4 comments
Labels
change request Issue requests a new feature or improvement resolved Issue is resolved, yet unreleased if open

Comments

@Guts
Copy link
Contributor

Guts commented Jul 7, 2022

Contribution guidelines

I want to suggest an idea and checked that ...

  • ... to my best knowledge, my idea wouldn't break something for other users
  • ... the documentation does not mention anything about my idea
  • ... there are no open or closed issues that are related to my idea

Description

Tag icons are great but they don't appear on the tags index page. It would be nice to have consistent icons between page, search and tags index.

I've tested with a quick setup:

mkdocs.yml

site_name: My Docs

plugins:
  - tags:
      tags_file: tags.md



theme:
  name: material
  icon:
    tag:
      html: fontawesome/brands/html5
      js: fontawesome/brands/js
      css:  fontawesome/brands/css3


extra:
  tags:
    test: html

docs/index.md :

---
tags:
    - test
    - trigger
---

# Test

tags icons tester

docs/tags.md:

# Tags

Following is a list of relevant tags:

[TAGS]

Use Cases

Every website using tag icons.

Screenshots / Mockups

Icon tag is present on page:

image

On search:

image

But not on index:

image

@squidfunk squidfunk added the change request Issue requests a new feature or improvement label Jul 7, 2022
@squidfunk
Copy link
Owner

Fixed in squidfunk/mkdocs-material-insiders@a733eca. Tag icons were not forgotten on the tags index page, but the mapping was missing – the tag name was used, not the icon mapping. Furthermore, search will now also display the # symbol, when no specific tag was set, but icons are used.

@squidfunk squidfunk added the resolved Issue is resolved, yet unreleased if open label Jul 7, 2022
@squidfunk
Copy link
Owner

squidfunk commented Jul 7, 2022

Released as part of 8.3.9+insiders-4.20.0.

@Guts
Copy link
Contributor Author

Guts commented Jul 7, 2022

Thanks! So it was a mini minor bug ;)

furthermore, search will now also display the # symbol, when no specific tag was set, but icons are used.

To be sure, in the case where a default icon is defined it is this one that will be used?

@squidfunk
Copy link
Owner

Jup, if you define tag icons, but have no specific icon defined for a tag, the default icon is used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change request Issue requests a new feature or improvement resolved Issue is resolved, yet unreleased if open
Projects
None yet
Development

No branches or pull requests

2 participants