Skip to content

Icon and emoji search #99

Description

@crbeckley-ic24

Description

The Material for MkDocs documentation page had a feature to search the emoji / icon database with copyable links that I found myself using very frequently while writing documentation. I know that the current Zensical docs have links to individual searches for the various included icon sets; however, this approach has two issues:

  1. It is not always intuitive on how to translate the icon set / icon name to the Zensical syntax (e.g. it took me a bit to figure out I needed :fontawesome-<icon pack>-<icon name>: for something like :fontawesome-brands-confluence:).
  2. It is much more convenient to have a "single pane of glass" for searching all available icon bundles as well as being able to click to copy the full syntax (which is not readily available in all of the linked icon sites).

A workaround for this is to use the existing Material for MkDocs emoji / icon search, but that doesn't cover all of the Zensical icon sets (e.g. Lucide).

Would it be possible to add this feature to the Zensical docs for all of the included icon / emoji sets?

Please note that I did search all issues in Zensical and Zensical docs as well as the public backlog and did not find anything related to this before creating the issue.

Related links

Proposed change

I traced some of the Material for MkDocs icon / emoji search div and found my way over to the Javascript overrides for icon search query and icon search result. My understanding is that additional Javascript and overrides are currently possible in Zensical, but I am not well versed in Javascript, so I am not sure if it's a fairly simple lift-and-shift to the Zensical docs or more complex.

I apologize, but due to this lack of front-end development knowledge, I will not reasonably be able to contribute a PR to help with this.

Before submitting

Activity

  1. squidfunk commented on Apr 18, 2026

    @squidfunk
    Member

    Thanks for suggesting! Definitely possible, and we might bring it back at some point. We skipped it due to time constraints when finishing the documentation site and getting everything ready for a release in November, but once I have some more time on my hands, we look into bringing it back. In the meantime, please use Material's icon search, as you mentioned ☺️

  2. changed the title [-]Request for icon sets / emoji search feature[/-] [+]Icon and emoji search[/+] on Apr 18, 2026
  3. crbeckley-ic24 commented on Apr 18, 2026

    @crbeckley-ic24
    Author

    Sounds good! Thank you for the quick response, and please feel free to close this issue out or keep open as you see fit.

  4. squidfunk commented on Aug 4, 2026

    @squidfunk
    Member

    Zensical Studio has completions for icons and emojis, including custom ones. However, it doesn't show them yet, since SVGs cannot be rendered in previews. We'll see how we can make them work nonetheless, because this would mean you would have icon completions exactly when you need them – right in your editor. We'll leave this issue open until Zensical Studio can render them.

    Image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationIssue concerns the documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions