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

Add inline image support to svg macro; attempt feature parity with built-in image: and image:: macros #143

Open
eric-schneider opened this issue Jun 27, 2024 · 0 comments
Labels
bug Something isn't working enhancement New feature or request P1

Comments

@eric-schneider
Copy link
Contributor

Note: The goal of this ticket is to allow the svg macro to be used for inline images. This is not to be confused with the opts=inline SVG attribute, which the svg macro already uses by default.

The svg macro syntax currently supports inline usage (svg:) and block usage (svg::). However, it appears that the macro only truly supports block images. This limits the macro's versatility and causes confusion for writers when the inline usage produces unexpected results.

Inline image support

There are cases where we'd like to be able to use the macro for inline images. For example, to achieve a table that looks like the following:

image

You would expect the syntax to look like this:

|===
|Embedding provider |External |Astra-hosted |Docs

|svg:ROOT:ui/icons/microsoft-azure-openai.svg[] Azure OpenAI <-- Macro inline with text
|[.material-icons]#check#
|
|xref:integrations:embedding-providers/azure-openai.adoc[Get started]
|===

However, because the macro generates a block image, the inline text gets bumped down into a new paragraph below the icon:

image

Feature parity with built-in image:: and image: macros

It would be ideal if the svg: and svg:: macro usages mirrored their image: and image:: counterparts in terms of their supported attributes and values.

@eric-schneider eric-schneider added bug Something isn't working enhancement New feature or request P2 labels Jun 27, 2024
@eric-schneider eric-schneider added P1 and removed P2 labels Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request P1
Projects
None yet
Development

No branches or pull requests

1 participant