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

display icons in the preview #1378

Open
themr0c opened this issue Jun 16, 2023 · 1 comment
Open

display icons in the preview #1378

themr0c opened this issue Jun 16, 2023 · 1 comment

Comments

@themr0c
Copy link

themr0c commented Jun 16, 2023

Why the new feature should be added

The preview should render icons, as it is part of the AsciiDoc language specification.

See: https://docs.asciidoctor.org/asciidoc/latest/macros/icons/

How the new feature should work

By default or when image icons are set, the preview should display the cloud image file in the directory specified by the iconsdir attribute.

= Document title

icon:cloud[]

When font icons are set, the preview should display the cloud font icon from the fas set:

= Document title
:icons: font

icon:cloud[set=fas]
@mojavelinux
Copy link
Member

mojavelinux commented Jun 16, 2023

The preview should render icons, as it is part of the AsciiDoc language specification.

I want to be very clear that the AsciiDoc user docs are not the AsciiDoc language specification. They are the initial contribution for drafting such a specification, as stated on https://docs.asciidoctor.org/asciidoc/latest/#about-this-documentation. Nothing that they state about that language has been ratified, though that initial contribution certainly does serve as the basis and common understanding on which we are building.

Font-based icons will not likely be part of the first version of the specification. They will remain an implementation provided feature. The icon macro will be defined, but in such a way that it creates an icon node that the implementation must convert appropriately (how it is interpreted is left up to the implementation).

I still agree that it would be good to see this in the preview. You just can't defend that request by saying it is part of the specification.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants