Skip to content

Icon and emoji search #99

@crbeckley-ic24

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

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