Which icons sytnax would you like to work with?

[reakaleek]

We are currently working on a Icons syntax, where you can use EUI icons.

Our initial idea was to use the :icon-name: syntax, which is known from GitHub or Slack. Unfortunately, this syntax conflicts with our MyST directive syntax.

:::{directive}
:option:
Content
:::

Hence, we want to know which syntax you would prefer to work with.

Options

MyST syntax

The icon is {icon}`check`.

i-prefix syntax

The icon is i:check:.

substitution-like

```markdown
The icon is {{icon:check}}.

[florent-leborgne]

Voted ✅ I like the substitution syntax because of how easy it is to see and understand. That said, I also like the i:icon: one

[Mpdreamz]

Myst role syntax for me! bit more verbose but fits our Myst inspired superset.

The substitution syntax is problematic for me scanning wise, it also makes grepping for variables slightly harder.

i-prefix, is a bit hard to scan too IMO, icon:icon-name: would be better e.g icon:logoElasticsearch: but then the Myst role syntax is equal in syntax for me.

[reakaleek]

We have 4 votes for the substitution-like syntax and 3 votes for the MyST syntax.

Since there is no clear winner (just one vote difference), we will probably go with the MyST syntax because there is already a parser for it and plays well with our existing ecosystem.